diff --git a/.gitignore b/.gitignore index 99b58d4b35cd..d207c334e7e3 100644 --- a/.gitignore +++ b/.gitignore @@ -100,3 +100,5 @@ AutoRest.* output/* errors.txt warnings.txt + +/dist/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index b2d65c0736b5..cb6367eb768b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,6 +16,7 @@ env: - MODE=semantic PR_ONLY=true CHECK_NAME="Semantic Validator" - MODE=semantic PR_ONLY=false - MODE=model PR_ONLY=true CHECK_NAME="Model Validator" + # - MODE=model PR_ONLY=false - MODE=BreakingChange PR_ONLY=true CHECK_NAME="Breaking Changes" - MODE=lintdiff PR_ONLY=true CHECK_NAME="Linter Diff" matrix: @@ -27,6 +28,7 @@ matrix: - 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=model PR_ONLY=true CHECK_NAME="Model Validator" - env: MODE=BreakingChange PR_ONLY=true CHECK_NAME="Breaking Changes" install: true diff --git a/CODEOWNERS b/CODEOWNERS index 802a9ad80a30..c6d2547a7ab9 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -14,7 +14,7 @@ /specification/consumption/ @kjeur @panda-wang /specification/containerinstance/ @samkreter /specification/containerregistry/ @djyou -/specification/containerservices/ @mboersma +/specification/containerservice/ @mboersma /specification/cosmos-db/ @dmakwana /specification/customer-insights/ @tjlvtao /specification/datafactory/ @zhangyd2015 diff --git a/arm-compute/quickstart-templates/aliases.json b/arm-compute/quickstart-templates/aliases.json index 2ee860c911c4..f5944d69cdbf 100644 --- a/arm-compute/quickstart-templates/aliases.json +++ b/arm-compute/quickstart-templates/aliases.json @@ -26,7 +26,7 @@ "Debian":{ "publisher":"credativ", "offer":"Debian", - "sku":"8", + "sku":"9", "version":"latest" }, "openSUSE-Leap": { @@ -44,13 +44,13 @@ "SLES":{ "publisher":"SUSE", "offer":"SLES", - "sku":"12-SP2", + "sku":"15", "version":"latest" }, "UbuntuLTS":{ "publisher":"Canonical", "offer":"UbuntuServer", - "sku":"16.04-LTS", + "sku":"18.04-LTS", "version":"latest" } }, diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index 00eeb7d8bd99..88ef6569942f 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -95,7 +95,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | Id | Rule Name | Applies to | | --- | --- | --- | -| [R4000](#r4000-2) | [ParameterDescriptionRequired](#r4000-2) | ARM and Data plane OpenAPI(swagger) specs | +| [R4000](#r4000) | [ParameterDescriptionRequired](#r4000) | ARM and Data plane OpenAPI(swagger) specs | | [R4000](#r4000-3) | [DescriptiveDescriptionRequired](#r4000-3) | ARM and Data plane OpenAPI(swagger) specs | | [R4000](#r4000-4) | [DescriptionAndTitleMissing](#r4000-4) | ARM and Data plane OpenAPI(swagger) specs | | [R4000](#r4000-5) | [OperationDescriptionOrSummaryRequired](#r4000-5) | ARM and Data plane OpenAPI(swagger) specs | @@ -1662,7 +1662,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) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R4000 ParameterDescriptionRequired +### R4000 ParameterDescriptionRequired **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs diff --git a/package.json b/package.json index 8d7a15738c6d..ca449a5d3535 100644 --- a/package.json +++ b/package.json @@ -13,17 +13,21 @@ "@microsoft.azure/async-io": "^1.0.21", "@microsoft.azure/literate": "^1.0.21", "@microsoft.azure/polyfill": "^1.0.17", - "@ts-common/local-install": "^0.0.8", + "@ts-common/commonmark-to-markdown": "^1.1.9", + "@ts-common/fs": "0.1.0", + "@types/js-yaml": "^3.12.0", "fs-extra": "^3.0.1", "glob": "^5.0.14", "js-yaml": "^3.8.2", "json-schema-ref-parser": "^3.1.2", "mocha": "*", "oad": "^0.1.11", - "oav": "^0.9.6", + "oav": "^0.13.4", "request": "^2.61.0", "request-promise-native": "^1.0.5", - "z-schema": "^3.24.2" + "typescript": "^3.2.4", + "z-schema": "^3.25.0", + "ts-node": "^8.0.1" }, "dependencies": { "@octokit/rest": "^15.2.6" @@ -39,6 +43,7 @@ "scripts": { "test": "mocha -t 500000 --reporter min", "oav": "oav", - "li": "local-install" + "tsc": "tsc", + "multiapi": "ts-node ./scripts/multiapi.ts" } } diff --git a/scripts/modelValidation.js b/scripts/modelValidation.js index 7cc0dc62611d..a2b0d89fa624 100644 --- a/scripts/modelValidation.js +++ b/scripts/modelValidation.js @@ -3,18 +3,38 @@ 'use strict'; const utils = require('../test/util/utils') -const oav = require('oav'); +const cp = require("child_process") + +const exec = (cmd, options) => { + const result = cp.spawnSync( + cmd, + { + ...options, + shell: true, + stdio: [process.stdin, process.stdout, process.stderr] + } + ) + return result.status +} 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); - // }); + let result = 0 for (const swagger of swaggersToProcess) { - await oav.validateExamples(swagger, null, {consoleLogLevel: 'error', pretty: true}); + try { + // await oav.validateExamples(swagger, null, {consoleLogLevel: 'error', pretty: true}); + // run OAV as a separate process to avoid memory issues. + const r = exec(`node node_modules/oav/dist/cli.js validate-example ${swagger} --pretty`) + if (result === 0) { + result = r + } + } catch (e) { + console.error("error: ") + console.error(e) + result = 1 + } } + return result } -main() \ No newline at end of file +main() diff --git a/scripts/momentOfTruth.js b/scripts/momentOfTruth.js index 079ca28e7bf8..9eb086c3f9c1 100644 --- a/scripts/momentOfTruth.js +++ b/scripts/momentOfTruth.js @@ -66,6 +66,7 @@ async function getLinterResult(swaggerPath) { let resultString = stdout + stderr; if (resultString.indexOf('{') !== -1) { + resultString = resultString.replace(/Processing batch task - {.*} \.\n/g, ""); resultString = "[" + resultString.substring(resultString.indexOf('{')).trim().replace(/\}\n\{/g, "},\n{") + "]"; //console.log('>>>>>> Trimmed Result...'); //console.log(resultString); diff --git a/scripts/multiapi.ts b/scripts/multiapi.ts new file mode 100644 index 000000000000..c7508904f776 --- /dev/null +++ b/scripts/multiapi.ts @@ -0,0 +1,66 @@ +import * as fs from "@ts-common/fs" +import * as process from "process" +import * as path from "path" +import * as cm from "@ts-common/commonmark-to-markdown" +import * as it from "@ts-common/iterator" +import * as yaml from "js-yaml" + +type Code = { + readonly "input-file"?: ReadonlyArray|string +} + +const main = async (dir: string) => { + try { + const list = fs.recursiveReaddir(dir) + for await (const file of list) { + const f = path.parse(file) + if (f.base === "readme.md") { + console.log(`processing ${file}`) + const content = (await fs.readFile(file)).toString() + const readMe = cm.parse(content) + const set = new Set() + for (const c of cm.iterate(readMe.markDown)) { + if ( + c.type === "code_block" && + c.info !== null && + c.info.startsWith("yaml") && + c.literal !== null + ) { + const y = (yaml.load(c.literal) as Code)["input-file"] + if (typeof y === "string") { + set.add(y) + } else if (it.isArray(y)) { + for (const i of y) { + set.add(i) + } + } + } + } + const readMeMulti = cm.createNode( + "document", + cm.createNode( + "heading", + cm.createText("Multi-API support for AutoRest v3 generators") + ), + cm.createNode( + "block_quote", + cm.createNode( + "paragraph", + cm.createText("see https://aka.ms/autorest") + ) + ), + cm.createCodeBlock( + "yaml $(enable-multi-api)", + yaml.dump({ "input-file": it.toArray(set) }, { lineWidth: 1000 }) + ) + ) + const x = cm.markDownExToString({ markDown: readMeMulti }) + fs.writeFile(path.join(f.dir, "readme.enable-multi-api.md"), x) + } + } + } catch (e) { + console.error(e) + } +} + +main(path.join(process.cwd(), "specification")) diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/EnterpriseKnowledgeGraphSwagger.json b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/EnterpriseKnowledgeGraphSwagger.json new file mode 100644 index 000000000000..7ba91a769693 --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/EnterpriseKnowledgeGraphSwagger.json @@ -0,0 +1,577 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Enterprise Knowledge Graph Service", + "description": "Azure Enterprise Knowledge Graph Service is a platform for creating knowledge graphs at scale.", + "version": "2018-12-03" + }, + "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.EnterpriseKnowledgeGraph/services/{resourceName}": { + "put": { + "tags": [ + "EnterpriseKnowledgeGraph" + ], + "description": "Creates a EnterpriseKnowledgeGraph Service. EnterpriseKnowledgeGraph Service is a resource group wide resource type.", + "operationId": "EnterpriseKnowledgeGraph_Create", + "x-ms-examples": { + "Create EnterpriseKnowledgeGraph": { + "$ref": "./examples/CreateEnterpriseKnowledgeGraph.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EnterpriseKnowledgeGraph" + }, + "description": "The parameters to provide for the created EnterpriseKnowledgeGraph." + }, + { + "$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/EnterpriseKnowledgeGraph" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Creating). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/EnterpriseKnowledgeGraph" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "EnterpriseKnowledgeGraph" + ], + "description": "Updates a EnterpriseKnowledgeGraph Service", + "operationId": "EnterpriseKnowledgeGraph_Update", + "x-ms-examples": { + "Update EnterpriseKnowledgeGraph": { + "$ref": "./examples/UpdateEnterpriseKnowledgeGraph.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/EnterpriseKnowledgeGraph" + }, + "description": "The parameters to provide for the created EnterpriseKnowledgeGraph." + }, + { + "$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/EnterpriseKnowledgeGraph" + } + }, + "201": { + "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/EnterpriseKnowledgeGraph" + } + }, + "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": [ + "EnterpriseKnowledgeGraph" + ], + "description": "Deletes a EnterpriseKnowledgeGraph Service from the resource group. ", + "operationId": "EnterpriseKnowledgeGraph_Delete", + "x-ms-examples": { + "Delete EnterpriseKnowledgeGraph": { + "$ref": "./examples/DeleteEnterpriseKnowledgeGraph.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": [ + "EnterpriseKnowledgeGraph" + ], + "description": "Returns a EnterpriseKnowledgeGraph service specified by the parameters.", + "operationId": "EnterpriseKnowledgeGraph_Get", + "x-ms-examples": { + "Get EnterpriseKnowledgeGraph": { + "$ref": "./examples/GetEnterpriseKnowledgeGraph.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/EnterpriseKnowledgeGraph" + } + }, + "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.EnterpriseKnowledgeGraph/services": { + "get": { + "tags": [ + "EnterpriseKnowledgeGraph" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "EnterpriseKnowledgeGraph_ListByResourceGroup", + "x-ms-examples": { + "List EnterpriseKnowledgeGraph by Resource Group": { + "$ref": "./examples/ListEnterpriseKnowledgeGraphByResourceGroup.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/EnterpriseKnowledgeGraphResponseList" + } + }, + "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.EnterpriseKnowledgeGraph/services": { + "get": { + "tags": [ + "EnterpriseKnowledgeGraph" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "EnterpriseKnowledgeGraph_List", + "x-ms-examples": { + "List EnterpriseKnowledgeGraph by Subscription": { + "$ref": "./examples/ListEnterpriseKnowledgeGraphBySubscription.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/EnterpriseKnowledgeGraphResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.EnterpriseKnowledgeGraph/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the available EnterpriseKnowledgeGraph services 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 + }, + "type": { + "description": "Specifies the type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the resource." + } + } + }, + "Sku": { + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "The sku name" + } + }, + "required": [ + "name" + ], + "description": "The SKU of the EnterpriseKnowledgeGraph service account." + }, + "SkuName": { + "type": "string", + "description": "The name of SKU.", + "enum": [ + "F0", + "S1" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "EnterpriseKnowledgeGraph": { + "description": "EnterpriseKnowledgeGraph resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EnterpriseKnowledgeGraphProperties", + "description": "The set of properties specific to EnterpriseKnowledgeGraph resource" + } + } + }, + "EnterpriseKnowledgeGraphProperties": { + "properties": { + "description": { + "type": "string", + "description": "The description of the EnterpriseKnowledgeGraph" + }, + "metadata": { + "description": "Specifies the metadata of the resource.", + "type": "object" + }, + "provisioningState": { + "type": "string", + "description": "The state of EnterpriseKnowledgeGraph provisioning", + "enum": [ + "Creating", + "Deleting", + "Failed", + "Succeeded" + ] + } + }, + "description": "The parameters to provide for the EnterpriseKnowledgeGraph." + }, + "EnterpriseKnowledgeGraphResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of EnterpriseKnowledgeGraph service resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/EnterpriseKnowledgeGraph" + }, + "description": "Gets the list of EnterpriseKnowledgeGraph service results and their properties." + } + }, + "description": "The list of EnterpriseKnowledgeGraph service operation response." + }, + "Error": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorBody", + "description": "The error body." + } + }, + "description": "EnterpriseKnowledgeGraph Service error object." + }, + "ErrorBody": { + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "description": "EnterpriseKnowledgeGraph Service error body.", + "required": [ + "code", + "message" + ] + }, + "OperationEntityListResult": { + "description": "The list of EnterpriseKnowledgeGraph 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 EnterpriseKnowledgeGraph Service Management.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by EnterpriseKnowledgeGraph Service Management." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + }, + "properties": { + "description": "Additional properties.", + "type": "object" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by EnterpriseKnowledgeGraph 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 EnterpriseKnowledgeGraph Service.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "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 EnterpriseKnowledgeGraph 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 EnterpriseKnowledgeGraph resource." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request." + } + } +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/CreateEnterpriseKnowledgeGraph.json b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/CreateEnterpriseKnowledgeGraph.json new file mode 100644 index 000000000000..d3c48e088cc5 --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/CreateEnterpriseKnowledgeGraph.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2018-12-03", + "resourceName": "sampleekgname", + "parameters": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + } + } + }, + "responses": { + "201": { + "name": "samplename", + "type": "sampletype", + "id": "someid", + "properties": { + "provisioningState": "Accepted" + } + } + } +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/DeleteEnterpriseKnowledgeGraph.json b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/DeleteEnterpriseKnowledgeGraph.json new file mode 100644 index 000000000000..f5324a2437b2 --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/DeleteEnterpriseKnowledgeGraph.json @@ -0,0 +1,22 @@ +{ + + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2018-12-03", + "resourceName": "sampleekgname" + }, + + "responses": { + + "200": { + + }, + + "204": { + + } + + } + +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/GetEnterpriseKnowledgeGraph.json b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/GetEnterpriseKnowledgeGraph.json new file mode 100644 index 000000000000..f2f838c2b0ed --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/GetEnterpriseKnowledgeGraph.json @@ -0,0 +1,30 @@ +{ + + "parameters": { + + "subscriptionId": "subscription-id", + + "resourceGroupName": "OneResourceGroupName", + + "api-version": "2018-12-03", + + "resourceName": "sampleekgname" + + }, + + "responses": { + + "200": { + + "name": "samplename", + + "type": "sampletype", + + "id": "someid", + + "properties": { + "provisioningState": "Succeedded" + } + } + } +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/GetOperations.json b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/GetOperations.json new file mode 100644 index 000000000000..0f8d2c7fa27c --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/GetOperations.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2018-12-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EnterpriseKnowledgeGraph/services/read", + "display": { + "provider": "Microsoft EnterpriseKnowledgeGraph Service", + "resource": "EnterpriseKnowledgeGraph Service", + "operation": "Read EnterpriseKnowledgeGraph resource", + "description": "Read EnterpriseKnowledgeGraph resources" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.EnterpriseKnowledgeGraph/services/write", + "display": { + "provider": "Microsoft EnterpriseKnowledgeGraph Service", + "resource": "EnterpriseKnowledgeGraph Service", + "operation": "Write EnterpriseKnowledgeGraph resource", + "description": "Writes EnterpriseKnowledgeGraph resources" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.EnterpriseKnowledgeGraph/services/delete", + "display": { + "provider": "Microsoft EnterpriseKnowledgeGraph Service", + "resource": "EnterpriseKnowledgeGraph Service", + "operation": "Delete EnterpriseKnowledgeGraph resource", + "description": "Deletes EnterpriseKnowledgeGraph resources" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.EnterpriseKnowledgeGraph/Operations/read", + "display": { + "provider": "Microsoft EnterpriseKnowledgeGraph Service", + "resource": "Operations", + "operation": "Read resource provider operations", + "description": "Read the operations for all resource types." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.EnterpriseKnowledgeGraph/locations/operationresults/read", + "display": { + "provider": "Microsoft EnterpriseKnowledgeGraph Service", + "resource": "Operation Result", + "operation": "Read Operation Result.", + "description": "Read the status of an asynchronous operation." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/ListEnterpriseKnowledgeGraphByResourceGroup.json b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/ListEnterpriseKnowledgeGraphByResourceGroup.json new file mode 100644 index 000000000000..dfa97ca9f1e4 --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/ListEnterpriseKnowledgeGraphByResourceGroup.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2018-12-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "samplename", + + "type": "sampletype", + + "id": "someid", + + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/ListEnterpriseKnowledgeGraphBySubscription.json b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/ListEnterpriseKnowledgeGraphBySubscription.json new file mode 100644 index 000000000000..13098893232a --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/ListEnterpriseKnowledgeGraphBySubscription.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "api-version": "2018-12-03" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "samplename", + + "type": "sampletype", + + "id": "someid", + + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/UpdateEnterpriseKnowledgeGraph.json b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/UpdateEnterpriseKnowledgeGraph.json new file mode 100644 index 000000000000..39544b4db5a5 --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/examples/UpdateEnterpriseKnowledgeGraph.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2018-12-03", + "resourceName": "sampleekgname", + "parameters": { + "location": "West US", + "sku": { + "name": "S1" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + } + } + }, + "responses": { + "201": { + "name": "samplename", + "type": "sampletype", + "id": "someid", + "properties": { + "provisioningState": "Accepted" + } + } + } +} diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/readme.go.md b/specification/EnterpriseKnowledgeGraph/resource-manager/readme.go.md new file mode 100644 index 000000000000..b15cdf7f29fa --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/readme.go.md @@ -0,0 +1,33 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: EnterpriseKnowledgeGraphService + clear-output-folder: true +``` + +### Go multi-api +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-12-03 + - tag: package-2018-12-03-preview +``` + +### Tag: package-2018-12 and go +These settings apply only when `--tag=package-2018-12 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-12' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/2018-12-03/$(namespace) +``` + +### Tag: package-2018-12-preview and go +These settings apply only when `--tag=package-2018-12-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-12-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/2018-12-31-preview/$(namespace) + diff --git a/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md b/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md new file mode 100644 index 000000000000..27a8d40dd344 --- /dev/null +++ b/specification/EnterpriseKnowledgeGraph/resource-manager/readme.md @@ -0,0 +1,91 @@ +# EnterpriseKnowledgeGraphService + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for EnterpriseKnowledgeGraphService. + + + +--- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-12-03 +``` + +### Tag: package-2018-12-03 and java + +These settings apply only when `--tag=package-2018-12-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-12-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.EnterpriseKnowledgeGraphservice.v2018-12-03 + output-folder: $(azure-libraries-for-java-folder)/EnterpriseKnowledgeGraphservice/resource-manager/v2018-12-03 +regenerate-manager: true +generate-interface: true +``` + + +## Getting Started +To build the SDK for EnterpriseKnowledgeGraphService, 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 EnterpriseKnowledgeGraphService API. + +``` yaml +openapi-type: arm +tag: package-2018-12-03 +``` + +### Tag: package-2018-12-03 + +These settings apply only when `--tag=package-2018-12-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-12-03' +input-file: +- Microsoft.EnterpriseKnowledgeGraph/preview/2018-12-03/EnterpriseKnowledgeGraphSwagger.json +directive: + - None at the moment +``` + +--- +# 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.EnterpriseKnowledgeGraphService + output-folder: $(csharp-sdks-folder)/EnterpriseKnowledgeGraphService/Microsoft.Azure.Management.EnterpriseKnowledgeGraphService/Generated + clear-output-folder: true +``` \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/AlertsManagement.json new file mode 100644 index 000000000000..6446c5077847 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/AlertsManagement.json @@ -0,0 +1,2150 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-11-02-privatepreview", + "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. Successfully 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. Successfully 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" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/actionRules": { + "get": { + "summary": "Get all action rule in a given subscription", + "description": "List all action rules of the subscription and given input filters", + "operationId": "ActionRules_GetAll_Subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/targetResourceGroup" + }, + { + "$ref": "#/parameters/targetResourceType" + }, + { + "$ref": "#/parameters/targetResource" + }, + { + "$ref": "#/parameters/severity" + }, + { + "$ref": "#/parameters/monitorService" + } + ], + "responses": { + "200": { + "description": "OK. Return the list of action rules", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/actionRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/actionRules": { + "get": { + "summary": "Get all action rules created in a resource group", + "operationId": "ActionRules_GetAll_ResourceGroup", + "description": "List all action rules of the subscription, created in given resource group and given input filters", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroup" + }, + { + "$ref": "#/parameters/targetResourceGroup" + }, + { + "$ref": "#/parameters/targetResourceType" + }, + { + "$ref": "#/parameters/targetResource" + }, + { + "$ref": "#/parameters/severity" + }, + { + "$ref": "#/parameters/monitorService" + } + ], + "responses": { + "200": { + "description": "OK. Return the list of action rules", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/actionRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}": { + "get": { + "summary": "Get action rule by name", + "operationId": "ActionRules_GetByName", + "description": "Get a specific action rule", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroup" + }, + { + "name": "actionRuleName", + "in": "path", + "description": "The name of action rule that needs to be fetched", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. Returns the specific action rule", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/actionRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + }, + "put": { + "summary": "Create/update an action rule", + "operationId": "ActionRules_CreateUpdate", + "description": "Creates/Updates a specific action rule", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroup" + }, + { + "name": "actionRuleName", + "in": "path", + "description": "The name of action rule that needs to be created/updated", + "required": true, + "type": "string" + }, + { + "name": "actionRule", + "in": "body", + "description": "action rule to be created/updated", + "required": true, + "schema": { + "$ref": "#/definitions/actionRule" + } + } + ], + "responses": { + "200": { + "description": "OK. Returns the created/updated action rule", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + }, + "schema": { + "$ref": "#/definitions/actionRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + }, + "delete": { + "summary": "Delete action rule", + "description": "Deletes a given action rule", + "operationId": "ActionRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroup" + }, + { + "name": "actionRuleName", + "in": "path", + "description": "The name that needs to be deleted", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. Returns true if deleted successfully", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + }, + "patch": { + "summary": "Patch action rule", + "description": "Update enabled flag and/or tags for the given action rule", + "operationId": "ActionRules_Patch", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroup" + }, + { + "name": "actionRuleName", + "in": "path", + "description": "The name that needs to be updated", + "required": true, + "type": "string" + }, + { + "name": "actionRulePatch", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/patchObject" + }, + "description": "Parameters supplied to the operation." + } + ], + "responses": { + "200": { + "description": "OK. Returns the created/updated action rule", + "headers": { + "x-ms-request-id": { + "type": "string", + "description": "Service generated Request ID." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + } + }, + "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 + }, + "resourceGroup": { + "name": "resourceGroup", + "description": "Resource group name where the resource is created.", + "type": "string", + "in": "path", + "required": true + }, + "api-version": { + "name": "api-version", + "description": "client API version", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "2018-11-02-privatepreview", + "2018-05-05" + ], + "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" + } + } + }, + "ManagedResource": { + "x-ms-azure-resource": true, + "description": "An azure managed resource object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ] + }, + "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." + } + } + }, + "scope": { + "type": "object", + "description": "Target scope for a given action rule. By default scope will be the subscription. User can also provide list of resource groups or list of resources from the scope subscription as well.", + "properties": { + "type": { + "type": "string", + "description": "type of target scope", + "enum": [ + "ResourceGroup", + "Resource" + ], + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + "values": { + "type": "array", + "description": "list of ARM IDs of the given scope type which will be the target of the given action rule.", + "items": { + "type": "string" + } + } + } + }, + "condition": { + "type": "object", + "description": "condition to trigger an action rule", + "properties": { + "operator": { + "type": "string", + "description": "operator for a given condition", + "enum": [ + "Equals", + "NotEquals", + "Contains", + "DoesNotContain" + ], + "x-ms-enum": { + "name": "ScopeType", + "modelAsString": true + } + }, + "values": { + "type": "array", + "description": "list of values to match for a given condition.", + "items": { + "type": "string" + } + } + } + }, + "conditions": { + "type": "object", + "description": "Conditions in alert instance to be matched for a given action rule. Default value is all. Multiple values could be provided with comma separation.", + "properties": { + "severity": { + "$ref": "#/definitions/condition" + }, + "monitorService": { + "$ref": "#/definitions/condition" + }, + "monitorCondition": { + "$ref": "#/definitions/condition" + }, + "signalType": { + "$ref": "#/definitions/condition" + }, + "targetResource": { + "$ref": "#/definitions/condition" + }, + "targetResourceGroup": { + "$ref": "#/definitions/condition" + }, + "targetResourceType": { + "$ref": "#/definitions/condition" + }, + "alertRuleId": { + "$ref": "#/definitions/condition" + }, + "description": { + "$ref": "#/definitions/condition" + }, + "logAnalyticsSearchResults": { + "$ref": "#/definitions/condition" + }, + "applicationInsightsSearchResults": { + "$ref": "#/definitions/condition" + } + } + }, + "suppressionConfig": { + "type": "object", + "discriminator": "recurrenceType", + "description": "Suppression logic for a given action rule", + "required": [ + "recurrenceType" + ], + "properties": { + "recurrenceType": { + "type": "string", + "description": "Specifies when the suppression should be applied", + "enum": [ + "Always", + "Once", + "Daily", + "Weekly", + "Monthly" + ], + "x-ms-enum": { + "name": "SuppressionType", + "modelAsString": true + } + }, + "schedule": { + "$ref": "#/definitions/suppressionSchedule" + } + } + }, + "suppressionSchedule": { + "type": "object", + "description": "Schedule for a given suppression configuration.", + "properties": { + "startDate": { + "type": "string", + "description": "Start date for suppression" + }, + "endDate": { + "type": "string", + "description": "End date for suppression" + }, + "startTime": { + "type": "string", + "description": "Start time for suppression" + }, + "endTime": { + "type": "string", + "description": "End date for suppression" + }, + "recurrenceValues": { + "type": "array", + "description": "Specifies the values for recurrence pattern", + "items": { + "type": "integer" + } + } + } + }, + "actionRule": { + "description": "Action rule object containing target scope, conditions and suppression logic", + "allOf": [ + { + "$ref": "#/definitions/ManagedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/actionRuleProperties" + } + } + }, + "actionRuleProperties": { + "description": "Action rule properties defining scope, conditions, suppression logic for action rule", + "properties": { + "scope": { + "$ref": "#/definitions/scope" + }, + "conditions": { + "$ref": "#/definitions/conditions" + }, + "suppressionConfig": { + "$ref": "#/definitions/suppressionConfig" + }, + "description": { + "type": "string", + "description": "Description of action rule" + }, + "resourceGroup": { + "type": "string", + "description": "Resource group where action rule is stored", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "Creation time of action rule. Date-Time in ISO-8601 format.", + "readOnly": true + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "Last updated time of action rule. Date-Time in ISO-8601 format.", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "Created by user name.", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "Last modified by user name.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Indicates if the given action rule is enabled or disabled", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "ActionRuleStatus", + "modelAsString": true + } + } + } + }, + "actionRulesList": { + "description": "List of action rules", + "properties": { + "nextLink": { + "type": "string", + "description": "URL to fetch the next set of action rules" + }, + "value": { + "type": "array", + "description": "List of action rules", + "items": { + "$ref": "#/definitions/actionRule" + } + } + } + }, + "patchObject": { + "description": "Properties supported by patch", + "properties": { + "status": { + "type": "string", + "description": "Indicates if the given action rule is enabled or disabled", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "ActionRuleStatus", + "modelAsString": true + } + }, + "tags": { + "type": "object", + "description": "tags to be updated" + } + } + } + } +} \ No newline at end of file diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Create.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Create.json new file mode 100644 index 000000000000..0b4141b3d087 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Create.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2018-11-02-privatepreview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d", + "resourceGroup": "alertscorrelationrg", + "actionRuleName": "DailySuppression", + "actionRule": { + "location": "Global", + "tags": {}, + "properties": { + "scope": { + "type": "ResourceGroup", + "values": ["/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg"] + }, + "conditions": { + "severity": { + "operator": "Equals", + "values": [ "Sev0", "Sev2" ] + }, + "monitorService": { + "operator": "Equals", + "values":[ "Platform", "Application Insights" ] + }, + "monitorCondition": { + "operator": "Equals", + "values":[ "Fired" ] + }, + "targetResourceType": { + "operator": "NotEquals", + "values":[ "Microsoft.Compute/VirtualMachines" ] + } + }, + "suppressionConfig": { + "recurrenceType" : "Daily", + "schedule": { + "startDate": "12/09/2018", + "endDate": "12/18/2018", + "startTime": "06:00:00", + "endTime": "14:00:00" + }, + }, + "description": "Action rule on resource group for daily suppression", + "resourceGroup": "alertscorrelationrg", + "status": "enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties":{ + "scope": { + "type": "ResourceGroup", + "values": ["/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg"] + }, + "conditions": { + "severity": { + "operator": "Equals", + "values": [ "Sev0", "Sev2" ] + }, + "monitorService": { + "operator": "Equals", + "values":[ "Platform", "Application Insights" ] + }, + "monitorCondition": { + "operator": "Equals", + "values":[ "Fired" ] + }, + "targetResourceType": { + "operator": "NotEquals", + "values":[ "Microsoft.Compute/VirtualMachines" ] + } + }, + "suppressionConfig": { + "recurrenceType" : "Daily", + "schedule": { + "startDate": "12/09/2018", + "endDate": "12/18/2018", + "startTime": "06:00:00", + "endTime": "14:00:00" + } + }, + "description": "Action rule on resource group for daily suppression", + "resourceGroup": "alertscorrelationrg", + "status": "enabled", + "startDateTime":"2018-06-12T22:05:09Z", + "lastModifiedDateTime":"2018-06-12T22:05:09Z", + "createdUserName":"abc@microsoft.com", + "lastModifiedUserName":"xyz@microsoft.com" + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression", + "type":"Microsoft.AlertsManagement/actionRules", + "name":"DailySuppression", + "location": "Global", + "tags": {} + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Delete.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Delete.json new file mode 100644 index 000000000000..c172fa0febef --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2018-11-02-privatepreview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d", + "resourceGroup": "alertscorrelationrg", + "actionRuleName": "DailySuppression", + }, + "responses": { + "200": { + "body": true + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_GetById.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_GetById.json new file mode 100644 index 000000000000..8f71d7768461 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_GetById.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2018-11-02-privatepreview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d", + "resourceGroup": "alertscorrelationrg", + "actionRuleName": "DailySuppression" + }, + "responses": { + "200": { + "body": { + "properties":{ + "scope": { + "type": "ResourceGroup", + "values": ["/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg"] + }, + "conditions": { + "severity": { + "operator": "Equals", + "values": [ "Sev0", "Sev2" ] + }, + "monitorService": { + "operator": "Equals", + "values":[ "Platform", "Application Insights" ] + }, + "monitorCondition": { + "operator": "Equals", + "values":[ "Fired" ] + }, + "targetResourceType": { + "operator": "NotEquals", + "values":[ "Microsoft.Compute/VirtualMachines" ] + } + }, + "suppressionConfig": { + "recurrenceType" : "Daily", + "schedule": { + "startDate": "12/09/2018", + "endDate": "12/18/2018", + "startTime": "06:00:00", + "endTime": "14:00:00" + } + }, + "description": "Action rule on resource group for daily suppression", + "resourceGroup": "alertscorrelationrg", + "status": "enabled", + "createdAt":"2018-06-12T22:05:09Z", + "lastModifiedAt":"2018-06-12T22:05:09Z", + "createdBy":"abc@microsoft.com", + "lastModifiedBy":"xyz@microsoft.com" + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression", + "type":"Microsoft.AlertsManagement/actionRules", + "name":"DailySuppression", + "location": "Global", + "tags": {} + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_List_ResourceGroup.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_List_ResourceGroup.json new file mode 100644 index 000000000000..94d0c89ad3bf --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_List_ResourceGroup.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2018-11-02-privatepreview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d", + "resourceGroup": "alertscorrelationrg" + }, + "responses": { + "200": { + "body": { + "nextLink":"https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules?api-version=2018-11-02-privatepreview&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1", + "value": [ + { + "properties":{ + "scope": { + "type": "ResourceGroup", + "values": ["/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg"] + }, + "conditions": { + "severity": { + "operator": "Equals", + "values": [ "Sev0", "Sev2" ] + }, + "monitorService": { + "operator": "Equals", + "values":[ "Platform", "Application Insights" ] + }, + "targetResourceType": { + "operator": "NotEquals", + "values":[ "Microsoft.Compute/VirtualMachines" ] + } + }, + "suppressionConfig": { + "recurrenceType" : "Daily", + "schedule": { + "startDate": "12/09/2018", + "endDate": "12/18/2018", + "startTime": "06:00:00", + "endTime": "14:00:00" + } + }, + "description": "Action rule on resource group for daily suppression", + "resourceGroup": "alertscorrelationrg", + "status": "enabled", + "createdAt":"2018-06-12T22:05:09Z", + "lastModifiedAt":"2018-06-12T22:05:09Z", + "createdBy":"abc@microsoft.com", + "lastModifiedBy":"xyz@microsoft.com" + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression", + "type":"Microsoft.AlertsManagement/actionRules", + "name":"DailySuppression", + "location": "Global", + "tags": {} + }, + { + "properties":{ + "scope": { + "type": "Resource", + "values": ["/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.Compute/VirtualMachines/testResource"] + }, + "conditions": { + "monitorCondition": { + "operator": "Equals", + "values": [ "Fired" ] + }, + "description": { + "operator": "Contains", + "values":[ "Percentage CPU greater than 80%", "Metric alert on resource foo" ] + }, + "targetResource": { + "operator": "DoesNotContain", + "values":[ "testresource", "foo" ] + } + }, + "suppressionConfig": { + "recurrenceType" : "Weekly", + "schedule": { + "startDate": "12/09/2018", + "endDate": "12/18/2018", + "startTime": "19:00:00", + "endTime": "10:00:00", + "recurrenceValues": [ 0, 3, 6 ] + } + }, + "description": "Action rule on resource group for weekly suppression", + "resourceGroup": "alertscorrelationrg", + "status": "enabled", + "createdAt":"2018-06-12T22:05:09Z", + "lastModifiedAt":"2018-06-12T22:05:09Z", + "createdBy":"abc@microsoft.com", + "lastModifiedBy":"xyz@microsoft.com" + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression", + "type":"Microsoft.AlertsManagement/actionRules", + "name":"WeeklySuppression", + "location": "Global", + "tags": {} + } + ] + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_List_Subscription.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_List_Subscription.json new file mode 100644 index 000000000000..5d5bbf2be548 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_List_Subscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2018-11-02-privatepreview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d" + }, + "responses": { + "200": { + "body": { + "nextLink":"https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/actionRules?api-version=2018-11-02-privatepreview&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1", + "value": [ + { + "properties":{ + "scope": { + "type": "ResourceGroup", + "values": ["/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg"] + }, + "conditions": { + "severity": { + "operator": "Equals", + "values": [ "Sev0", "Sev2" ] + }, + "monitorService": { + "operator": "Equals", + "values":[ "Platform", "Application Insights" ] + }, + "targetResourceType": { + "operator": "NotEquals", + "values":[ "Microsoft.Compute/VirtualMachines" ] + } + }, + "suppressionConfig": { + "recurrenceType" : "Daily", + "schedule": { + "startDate": "12/09/2018", + "endDate": "12/18/2018", + "startTime": "06:00:00", + "endTime": "14:00:00" + } + }, + "description": "Action rule on resource group for daily suppression", + "resourceGroup": "alertscorrelationrg", + "status": "enabled", + "createdAt":"2018-06-12T22:05:09Z", + "lastModifiedAt":"2018-06-12T22:05:09Z", + "createdBy":"abc@microsoft.com", + "lastModifiedBy":"xyz@microsoft.com" + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression", + "type":"Microsoft.AlertsManagement/actionRules", + "name":"DailySuppression", + "location": "Global", + "tags": {} + }, + { + "properties":{ + "scope": { + "type": "Resource", + "values": ["/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.Compute/VirtualMachines/testResource"] + }, + "conditions": { + "monitorCondition": { + "operator": "Equals", + "values": [ "Fired" ] + }, + "description": { + "operator": "Contains", + "values":[ "Percentage CPU greater than 80%", "Metric alert on resource foo" ] + } + }, + "suppressionConfig": { + "recurrenceType" : "Weekly", + "schedule": { + "startDate": "12/09/2018", + "endDate": "12/18/2018", + "startTime": "19:00:00", + "endTime": "10:00:00", + "recurrenceValues": [ 0, 3, 6 ] + } + }, + "description": "Action rule on resource group for weekly suppression", + "resourceGroup": "alertsrg", + "status": "enabled", + "createdAt":"2018-06-12T22:05:09Z", + "lastModifiedAt":"2018-06-12T22:05:09Z", + "createdBy":"abc@microsoft.com", + "lastModifiedBy":"xyz@microsoft.com" + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/WeeklySuppression", + "type":"Microsoft.AlertsManagement/actionRules", + "name":"WeeklySuppression", + "location": "Global", + "tags": {} + } + ] + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Patch.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Patch.json new file mode 100644 index 000000000000..52adeedd67e9 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/ActionRules_Patch.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2018-11-02-privatepreview", + "subscriptionId": "1e3ff1c0-771a-4119-a03b-be82a51e232d", + "resourceGroup": "alertscorrelationrg", + "actionRuleName": "DailySuppression", + "actionRulePatch": { + "tags": { "key1": "value1", "key2": "value2" }, + "properties": { + "status": "disabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties":{ + "scope": { + "type": "ResourceGroup", + "values": ["/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg"] + }, + "conditions": { + "severity": { + "operator": "Equals", + "values": [ "Sev0", "Sev2" ] + }, + "monitorService": { + "operator": "Equals", + "values":[ "Platform", "Application Insights" ] + }, + "targetResourceType": { + "operator": "NotEquals", + "values":[ "Microsoft.Compute/VirtualMachines" ] + } + }, + "suppressionConfig": { + "recurrenceType" : "Daily", + "schedule": { + "startDate": "12/09/2018", + "endDate": "12/18/2018", + "startTime": "06:00:00", + "endTime": "14:00:00" + } + }, + "description": "Action rule on resource group for daily suppression", + "resourceGroup": "alertscorrelationrg", + "status": "disabled", + "createdAt":"2018-06-12T22:05:09Z", + "lastModifiedAt":"2018-06-12T22:05:09Z", + "createdBy":"abc@microsoft.com", + "lastModifiedBy":"xyz@microsoft.com" + }, + "id":"/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/resourceGroups/alertscorrelationrg/providers/Microsoft.AlertsManagement/actionRules/DailySuppression", + "type":"Microsoft.AlertsManagement/actionRules", + "name":"DailySuppression", + "location": "Global", + "tags": { "key1": "value1", "key2": "value2" } + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_ChangeState.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_ChangeState.json new file mode 100644 index 000000000000..b77a6029fb67 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/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-11-02-privatepreview/examples/Alerts_GetById.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_GetById.json new file mode 100644 index 000000000000..e86cf49039d2 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_GetById.json @@ -0,0 +1,36 @@ +{ + "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" + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_History.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_History.json new file mode 100644 index 000000000000..2305f2aa9598 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/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-11-02-privatepreview/examples/Alerts_List.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_List.json new file mode 100644 index 000000000000..ae3b603b6b98 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_List.json @@ -0,0 +1,62 @@ +{ + "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" + } + ] + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_Summary.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_Summary.json new file mode 100644 index 000000000000..06f70e61e736 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/Alerts_Summary.json @@ -0,0 +1,90 @@ +{ + "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" + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_ChangeState.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_ChangeState.json new file mode 100644 index 000000000000..f620cdb8fad5 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_ChangeState.json @@ -0,0 +1,75 @@ +{ + "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" + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_GetById.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_GetById.json new file mode 100644 index 000000000000..41967911e018 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_GetById.json @@ -0,0 +1,71 @@ +{ + "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" + } + } + } +} + diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_History.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_History.json new file mode 100644 index 000000000000..8388cabc6940 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_History.json @@ -0,0 +1,31 @@ +{ + "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-11-02-privatepreview/examples/SmartGroups_List.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_List.json new file mode 100644 index 000000000000..582e9b137ec5 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/examples/SmartGroups_List.json @@ -0,0 +1,146 @@ +{ + "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" + } + ] + } + } + } +} + 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 index e79c7e9f84bc..a4d0066e0a17 100644 --- 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 @@ -169,7 +169,9 @@ "application/json", "application/vnd.sun.wadl+xml", "application/vnd.swagger.doc+json", - "application/wsdl+xml" + "application/wsdl+xml", + "application/vnd.oai.openapi", + "application/vnd.oai.openapi+json" ], "parameters": [ { @@ -216,6 +218,9 @@ "operationId": "Api_CreateOrUpdate", "description": "Creates new or updates existing specified API of the API Management service instance.", "x-ms-examples": { + "ApiManagementCreateApiUsingOai3Import": { + "$ref": "./examples/ApiManagementCreateApiUsingOai3Import.json" + }, "ApiManagementCreateApiUsingSwaggerImport": { "$ref": "./examples/ApiManagementCreateApiUsingSwaggerImport.json" }, @@ -242,7 +247,9 @@ "application/json", "application/vnd.sun.wadl+xml", "application/vnd.swagger.doc+json", - "application/wsdl+xml" + "application/wsdl+xml", + "application/vnd.oai.openapi", + "application/vnd.oai.openapi+json" ], "parameters": [ { @@ -3395,7 +3402,8 @@ "enum": [ "swagger-link", "wadl-link", - "wsdl-link" + "wsdl-link", + "openapi-link" ], "x-ms-enum": { "name": "ExportFormat", @@ -3415,6 +3423,11 @@ "value": "wadl-link", "description": "Export the Api Definition in WADL Schema to Storage Blob.", "name": "Wadl" + }, + { + "value": "openapi-link", + "description": "Export the Api Definition in OpenApi Specification 3.0 to Storage Blob.", + "name": "OpenApi3" } ] }, @@ -3526,7 +3539,10 @@ "swagger-json", "swagger-link-json", "wsdl", - "wsdl-link" + "wsdl-link", + "openapi", + "openapi+json", + "openapi-link" ], "x-ms-enum": { "name": "ContentFormat", @@ -3555,6 +3571,18 @@ { "value": "wsdl-link", "description": "The WSDL document is hosted on a publicly accessible internet address." + }, + { + "value": "openapi", + "description": "The contents are inline and Content Type is a OpenApi 3.0 Document in YAML format." + }, + { + "value": "openapi+json", + "description": "The contents are inline and Content Type is a OpenApi 3.0 Document in JSON format." + }, + { + "value": "openapi-link", + "description": "The Open Api 3.0 document is hosted on a publicly accessible internet address." } ] } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json new file mode 100644 index 000000000000..ce7e2a60061d --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementCreateApiUsingOai3Import.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "petstore", + "parameters": { + "properties": { + "contentFormat": "openapi-link", + "contentValue": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml", + "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", + "serviceUrl": "http://petstore.swagger.io/v1", + "path": "petstore", + "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/petstoreapi", + "type": "Microsoft.ApiManagement/service/apis", + "name": "petstoreapi", + "properties": { + "displayName": "Swagger Petstore", + "apiRevision": "1", + "serviceUrl": "http://petstore.swagger.io/v1", + "path": "petstore", + "protocols": [ + "https" + ], + "subscriptionKeyParameterNames": { + "header": "Ocp-Apim-Subscription-Key", + "query": "subscription-key" + }, + "isCurrent": true + } + } + } + } +} \ 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 3a80520e1ca2..2e77d39b9f9b 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 @@ -864,6 +864,25 @@ } } } + }, + "/providers/Microsoft.Authorization/elevateAccess": { + "post": { + "tags": [ + "ElevateAccess" + ], + "operationId": "ElevateAccess_Post", + "description": "Elevates access for a Global Administrator.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an HttpResponseMessage with HttpStatusCode 200." + } + } + } } }, "x-ms-paths": { @@ -1227,4 +1246,4 @@ "description": "The API version to use for this operation." } } -} \ No newline at end of file +} diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json index 8c35ade928dc..a18cbb523c8f 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json @@ -15,8 +15,8 @@ "type": "Microsoft.Storage.Admin/locations/quotas", "location": "local", "properties": { - "numberOfStorageAccounts": -1000000000, - "capacityInGb": -100000000 + "numberOfStorageAccounts": 20, + "capacityInGb": 2048 } } ] diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersCheckNameAvailability.json new file mode 100644 index 000000000000..7403c8ef82b8 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersCheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2019-01-21", + "location": "wus", + "clusterName": { + "name": "kuskusprod", + "type": "Microsoft.Kusto/Clusters" + } + }, + "responses": { + "200": { + "body": { + "name": "kuskusprod", + "nameAvailable": false, + "message": "Name 'kuskusprod' is already taken. Please specify a different name" + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersCreateOrUpdate.json new file mode 100644 index 000000000000..03bcb2d03594 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersCreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "api-version": "2019-01-21", + "parameters": { + "location": "westus", + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersDelete.json new file mode 100644 index 000000000000..9234b8e61552 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "api-version": "2019-01-21" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersGet.json new file mode 100644 index 000000000000..0fd12cb1ab7a --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersList.json new file mode 100644 index 000000000000..fb4f5ed93a24 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", + "name": "KustoClusterRPTest3", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListByResourceGroup.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListByResourceGroup.json new file mode 100644 index 000000000000..e980cdbb1605 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", + "name": "KustoClusterRPTest3", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListResourceSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListResourceSkus.json new file mode 100644 index 000000000000..c890116019fc --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListResourceSkus.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "clusters", + "sku": { + "name": "D13_v2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "D14_v2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "L8", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "L16", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListSkus.json new file mode 100644 index 000000000000..9e80353aa036 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersListSkus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "D13_v2", + "tier": "Standard", + "capacity": 2 + }, + { + "name": "D14_v2", + "tier": "Standard", + "capacity": 2 + }, + { + "name": "L8", + "tier": "Standard", + "capacity": 2 + }, + { + "name": "L16", + "tier": "Standard", + "capacity": 2 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersStart.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersStart.json new file mode 100644 index 000000000000..94667ea3d882 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "api-version": "2019-01-21" + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersStop.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersStop.json new file mode 100644 index 000000000000..94667ea3d882 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "api-version": "2019-01-21" + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersUpdate.json new file mode 100644 index 000000000000..c13e894858db --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoClustersUpdate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "api-version": "2019-01-21", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "L8", + "capacity": 2, + "tier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionValidation.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionValidation.json new file mode 100644 index 000000000000..86135cad805d --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionValidation.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21", + "dataConnectionName": "DataConnections8", + "parameters": { + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": + [ + { + "errorMessage": "event hub namespace does not exist" + }, + { + "errorMessage": "database does not exist" + } + ] + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsCreateOrUpdate.json new file mode 100644 index 000000000000..801e2d336540 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsCreateOrUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21", + "dataConnectionName": "DataConnections8", + "parameters": { + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "201": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsDelete.json new file mode 100644 index 000000000000..7960e399c939 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21", + "dataConnectionName": "kustoeventhubconnection1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsGet.json new file mode 100644 index 000000000000..aacc0baca9a7 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21", + "dataConnectionName": "DataConnections8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsListByDatabase.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsListByDatabase.json new file mode 100644 index 000000000000..61721f996afa --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsListByDatabase.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/KustoDataConnection8", + "name": "KustoClusterRPTest4/KustoDatabase8/KustoDataConnection8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9/DataConnections/KustoDataConnection9", + "name": "KustoClusterRPTest4/KustoDatabase9/KustoDataConnection9", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns2/eventhubs/eventhubTest2", + "consumerGroup": "testConsumerGroup2" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsUpdate.json new file mode 100644 index 000000000000..968155a912f3 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDataConnectionsUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21", + "dataConnectionName": "DataConnections8", + "parameters": { + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "201": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseAddPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseAddPrincipals.json new file mode 100644 index 000000000000..29d9328dc6cd --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseAddPrincipals.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "databaseName1", + "api-version": "2019-01-21", + "databasePrincipalsToAdd": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseListPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseListPrincipals.json new file mode 100644 index 000000000000..5880ecd761a7 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseListPrincipals.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "databaseName1", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseRemovePrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseRemovePrincipals.json new file mode 100644 index 000000000000..fd53beb66edb --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabaseRemovePrincipals.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "databaseName1", + "api-version": "2019-01-21", + "databasePrincipalsToRemove": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesCheckNameAvailability.json new file mode 100644 index 000000000000..5fd3ed55cd53 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2019-01-21", + "resourceGroupName": "kustorptest", + "clusterName": "kustoProd", + "databaseName": { + "name": "kuskus", + "type": "Microsoft.Kusto/Clusters/Databases" + } + }, + "responses": { + "200": { + "body": { + "name": "kuskus", + "nameAvailable": false, + "message": "Name 'kuskus' is already taken. Please specify a different name" + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesCreateOrUpdate.json new file mode 100644 index 000000000000..fadab650286a --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesCreateOrUpdate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21", + "parameters": { + "location": "westus", + "properties": { + "softDeletePeriod": "P1D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "201": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesDelete.json new file mode 100644 index 000000000000..163fed0c1086 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesGet.json new file mode 100644 index 000000000000..ce574b10b534 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesListByCluster.json new file mode 100644 index 000000000000..909f64ff452e --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesListByCluster.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9", + "name": "KustoClusterRPTest4/KustoDatabase9", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesUpdate.json new file mode 100644 index 000000000000..efdb383dfe0e --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoDatabasesUpdate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "KustoClusterRPTest4", + "databaseName": "KustoDatabase8", + "api-version": "2019-01-21", + "parameters": { + "location": "westus", + "properties": { + "softDeletePeriod": "P1D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "201": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoOperationsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoOperationsList.json new file mode 100644 index 000000000000..a5f4328bba90 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/examples/KustoOperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2019-01-21" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "provider": "providerName", + "resource": "resourceName", + "operation": "operationName", + "description": "operation description" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/kusto.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/kusto.json new file mode 100644 index 000000000000..ccd9d4950e79 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2019-01-21/kusto.json @@ -0,0 +1,2188 @@ +{ + "swagger": "2.0", + "info": { + "title": "KustoManagementClient", + "version": "2019-01-21" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "KustoClustersGet": { + "$ref": "./examples/KustoClustersGet.json" + } + }, + "description": "Gets a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Kusto cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_CreateOrUpdate", + "x-ms-examples": { + "KustoClustersCreateOrUpdate": { + "$ref": "./examples/KustoClustersCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Create or update a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "The Kusto cluster parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the Cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Successfully created the cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "x-ms-examples": { + "KustoClustersUpdate": { + "$ref": "./examples/KustoClustersUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Update a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdate" + }, + "description": "The Kusto cluster parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the Cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Successfully updated the cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "x-ms-examples": { + "KustoClustersDelete": { + "$ref": "./examples/KustoClustersDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- cluster deleted successfully." + }, + "202": { + "description": "Accepted the delete cluster request." + }, + "204": { + "description": "NoContent -- cluster does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Stop", + "x-ms-examples": { + "KustoClustersStop": { + "$ref": "./examples/KustoClustersStop.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Stops a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Start", + "x-ms-examples": { + "KustoClustersStart": { + "$ref": "./examples/KustoClustersStart.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Starts a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "KustoClustersListByResourceGroup": { + "$ref": "./examples/KustoClustersListByResourceGroup.json" + } + }, + "description": "Lists all Kusto clusters within a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_List", + "x-ms-examples": { + "KustoClustersList": { + "$ref": "./examples/KustoClustersList.json" + } + }, + "description": "Lists all Kusto clusters within a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus": { + "get": { + "description": "Lists eligible SKUs for Kusto resource provider.", + "x-ms-examples": { + "KustoClustersListSkus": { + "$ref": "./examples/KustoClustersListSkus.json" + } + }, + "operationId": "Clusters_ListSkus", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { "$ref": "#/definitions/ListSkusResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_CheckNameAvailability", + "x-ms-examples": { + "KustoClustersCheckNameAvailability": { + "$ref": "./examples/KustoClustersCheckNameAvailability.json" + } + }, + "description": "Checks that the cluster name is valid and is not already in use.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "Azure location.", + "required": true, + "type": "string" + }, + { + "name": "clusterName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterCheckNameRequest" + }, + "description": "The name of the cluster." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability": { + "post": { + "tags": [ + "Databases" + ], + "operationId": "Databases_CheckNameAvailability", + "x-ms-examples": { + "KustoDatabaseCheckNameAvailability": { + "$ref": "./examples/KustoDatabasesCheckNameAvailability.json" + } + }, + "description": "Checks that the database name is valid and is not already in use.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "databaseName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseCheckNameRequest" + }, + "description": "The name of the database." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListSkusByResource", + "x-ms-examples": { + "KustoClustersListResourceSkus": { + "$ref": "./examples/KustoClustersListResourceSkus.json" + } + }, + "description": "Returns the SKUs available for the provided resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { "$ref": "#/definitions/ListResourceSkusResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "description": "Returns the list of databases of the given Kusto cluster.", + "operationId": "Databases_ListByCluster", + "x-ms-examples": { + "KustoDatabasesListByCluster": { + "$ref": "./examples/KustoDatabasesListByCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of databases.", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}": { + "get": { + "tags": [ + "Databases" + ], + "description": "Returns a database.", + "operationId": "Databases_Get", + "x-ms-examples": { + "KustoDatabasesGet": { + "$ref": "./examples/KustoDatabasesGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Databases" + ], + "description": "Creates or updates a database.", + "operationId": "Databases_CreateOrUpdate", + "x-ms-examples": { + "KustoDatabasesCreateOrUpdate": { + "$ref": "./examples/KustoDatabasesCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "The database parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Successfully created the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted the create database request." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Databases" + ], + "description": "Updates a database.", + "operationId": "Databases_Update", + "x-ms-examples": { + "KustoDatabasesUpdate": { + "$ref": "./examples/KustoDatabasesUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseUpdate" + }, + "description": "The database parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted the update database request." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Databases" + ], + "description": "Deletes the database with the given name.", + "operationId": "Databases_Delete", + "x-ms-examples": { + "KustoDatabasesDelete": { + "$ref": "./examples/KustoDatabasesDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the database." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "The specified database does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals": { + "post": { + "tags": [ + "Databases" + ], + "description": "Returns a list of database principals of the given Kusto cluster and database.", + "operationId": "Databases_ListPrincipals", + "x-ms-examples": { + "KustoDatabaseListPrincipals": { + "$ref": "./examples/KustoDatabaseListPrincipals.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of database principals.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals": { + "post": { + "tags": [ + "Databases" + ], + "operationId": "Databases_AddPrincipals", + "x-ms-examples": { + "KustoDatabaseAddPrincipals": { + "$ref": "./examples/KustoDatabaseAddPrincipals.json" + } + }, + "description": "Add Database principals permissions.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "databasePrincipalsToAdd", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabasePrincipalListRequest" + }, + "description": "List of database principals to add." + } + ], + "responses": { + "200": { + "description": "OK -- Successfully added the list of database principals. Returns the updated list of principals.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals": { + "post": { + "tags": [ + "Databases" + ], + "operationId": "Databases_RemovePrincipals", + "x-ms-examples": { + "KustoDatabaseRemovePrincipals": { + "$ref": "./examples/KustoDatabaseRemovePrincipals.json" + } + }, + "description": "Remove Database principals permissions.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "databasePrincipalsToRemove", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabasePrincipalListRequest" + }, + "description": "List of database principals to remove." + } + ], + "responses": { + "200": { + "description": "OK -- Successfully removed the list of database principals. Returns the updated list of principals.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections": { + "get": { + "tags": [ + "DataConnections" + ], + "description": "Returns the list of data connections of the given Kusto database.", + "operationId": "DataConnections_ListByDatabase", + "x-ms-examples": { + "KustoDatabasesListByCluster": { + "$ref": "./examples/KustoDataConnectionsListByDatabase.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of data connections.", + "schema": { + "$ref": "#/definitions/DataConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnectionValidation": { + "post": { + "tags": [ + "DataConnections" + ], + "operationId": "DataConnections_dataConnectionValidation", + "x-ms-examples": { + "KustoDataConnectionValidation": { + "$ref": "./examples/KustoDataConnectionValidation.json" + } + }, + "description": "Checks that the data connection parameters are valid.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectionValidation" + }, + "description": "The data connection parameters supplied to the CreateOrUpdate operation." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/DataConnectionValidationListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}": { + "get": { + "tags": [ + "DataConnections" + ], + "description": "Returns a data connection.", + "operationId": "DataConnections_Get", + "x-ms-examples": { + "KustoDataConnectionsGet": { + "$ref": "./examples/KustoDataConnectionsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/DataConnectionNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "DataConnections" + ], + "description": "Creates or updates a data connection.", + "operationId": "DataConnections_CreateOrUpdate", + "x-ms-examples": { + "KustoDataConnectionsCreateOrUpdate": { + "$ref": "./examples/KustoDataConnectionsCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/DataConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnection" + }, + "description": "The data connection parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "201": { + "description": "Successfully created the data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "202": { + "description": "Accepted the create data connection request." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DataConnections" + ], + "description": "Updates a data connection.", + "operationId": "DataConnections_Update", + "x-ms-examples": { + "KustoDataConnectionsUpdate": { + "$ref": "./examples/KustoDataConnectionsUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/DataConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnection" + }, + "description": "The data connection parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "201": { + "description": "Successfully updated the data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "202": { + "description": "Accepted the update data connection request." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "DataConnections" + ], + "description": "Deletes the data connection with the given name.", + "operationId": "DataConnections_Delete", + "x-ms-examples": { + "KustoDataConnectionsDelete": { + "$ref": "./examples/KustoDataConnectionsDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/DataConnectionNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the data connection." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "The specified data connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Kusto/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "KustoOperationsList": { + "$ref": "./examples/KustoOperationsList.json" + } + }, + "description": "Lists available operations for the Microsoft.Kusto provider.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ClusterProperties": { + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the resource.", + "enum": [ + "Creating", + "Unavailable", + "Running", + "Deleting", + "Deleted", + "Stopping", + "Stopped", + "Starting", + "Updating" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioned state of the resource.", + "enum": [ + "Running", + "Creating", + "Deleting", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "uri": { + "type": "string", + "readOnly": true, + "description": "The cluster URI." + }, + "dataIngestionUri": { + "type": "string", + "readOnly": true, + "description": "The cluster data ingestion URI." + }, + "trustedExternalTenants": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedExternalTenant" + }, + "description": "The cluster's external tenants." + } + }, + "description": "Class representing the Kusto cluster properties." + }, + "TrustedExternalTenant": { + "properties": { + "value": { + "type": "string", + "description": "GUID representing an external tenant." + } + }, + "description": "Represents a tenant ID that is trusted by the cluster." + }, + "AzureResourceSku": { + "properties": { + "resourceType": { + "type": "string", + "description": "Resource Namespace and Type." + }, + "sku": { + "$ref": "#/definitions/AzureSku", + "description": "The SKU details." + }, + "capacity": { + "$ref": "#/definitions/AzureCapacity", + "description": "The SKU capacity." + } + }, + "description": "Azure resource SKU definition." + }, + "AzureCapacity": { + "type": "object", + "required": [ + "minimum", + "maximum", + "default", + "scaleType" + ], + "properties": { + "scaleType": { + "description": "Scale type.", + "type": "string", + "enum": [ + "automatic", + "manual", + "none" + ], + "x-ms-enum": { + "name": "AzureScaleType", + "modelAsString": true + } + }, + "minimum": { + "description": "Minimum allowed capacity.", + "type": "integer" + }, + "maximum": { + "description": "Maximum allowed capacity.", + "type": "integer" + }, + "default": { + "description": "The default capacity that would be used.", + "type": "integer" + } + }, + "description": "Azure capacity definition." + }, + "AzureSku": { + "type": "object", + "required": [ + "name", + "tier" + ], + "properties": { + "name": { + "description": "SKU name.", + "type": "string", + "enum": [ + "D13_v2", + "D14_v2", + "L8", + "L16", + "D11_v2", + "D12_v2", + "L4" + ], + "x-ms-enum": { + "name": "AzureSkuName", + "modelAsString": true + } + }, + "capacity": { + "description": "SKU capacity.", + "type": "integer" + }, + "tier": { + "description": "SKU tier.", + "type": "string", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "AzureSkuTier", + "modelAsString": true + } + } + }, + "description": "Azure SKU definition." + }, + "DatabaseStatistics": { + "type": "object", + "readOnly": true, + "properties": { + "size": { + "type": "number", + "description": "The database size - the total size of compressed data and index in bytes." + } + }, + "description": "A class that contains database statistics information." + }, + "DatabaseProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioned state of the resource.", + "enum": [ + "Running", + "Creating", + "Deleting", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "softDeletePeriod": { + "type": "string", + "format": "duration", + "description": "The time the data should be kept before it stops being accessible to queries in TimeSpan." + }, + "hotCachePeriod": { + "type": "string", + "format": "duration", + "description": "The time the data that should be kept in cache for fast queries in TimeSpan." + }, + "statistics": { + "$ref": "#/definitions/DatabaseStatistics", + "description": "The statistics of the database." + } + }, + "description": "Class representing the Kusto database properties." + }, + "EventHubConnectionProperties": { + "properties": { + "eventHubResourceId": { + "type": "string", + "description": "The resource ID of the event hub to be used to create a data connection." + }, + "consumerGroup": { + "type": "string", + "description": "The event hub consumer group." + }, + "tableName": { + "type": "string", + "description": "The table where the data should be ingested. Optionally the table information can be added to each message." + }, + "mappingRuleName": { + "type": "string", + "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." + }, + "dataFormat": { + "$ref": "#/definitions/DataFormat", + "description": "The data format of the message. Optionally the data format can be added to each message." + } + }, + "required": [ + "eventHubResourceId", + "consumerGroup" + ], + "description": "Class representing the Kusto event hub connection properties." + }, + "DataFormat": { + "description": "The data format of the message. Optionally the data format can be added to each message.", + "type": "string", + "enum": [ + "MULTIJSON", + "JSON", + "CSV", + "TSV", + "SCSV", + "SOHSV", + "PSV", + "TXT", + "RAW", + "SINGLEJSON", + "AVRO" + ], + "x-ms-enum": { + "name": "dataFormat", + "modelAsString": true + } + }, + "EventGridConnectionProperties": { + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "The resource ID of the storage account where the data resides." + }, + "eventHubResourceId": { + "type": "string", + "description": "The resource ID where the event grid is configured to send events." + }, + "consumerGroup": { + "type": "string", + "description": "The event hub consumer group." + }, + "tableName": { + "type": "string", + "description": "The table where the data should be ingested. Optionally the table information can be added to each message." + }, + "mappingRuleName": { + "type": "string", + "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." + }, + "dataFormat": { + "$ref": "#/definitions/DataFormat", + "description": "The data format of the message. Optionally the data format can be added to each message." + } + }, + "required": [ + "storageAccountResourceId", + "eventHubResourceId", + "consumerGroup", + "tableName", + "dataFormat" + ], + "description": "Class representing the Kusto event grid connection properties." + }, + "Cluster": { + "required": [ + "sku" + ], + "properties": { + "sku": { + "$ref": "#/definitions/AzureSku", + "description": "The SKU of the cluster." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "The cluster properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Class representing a Kusto cluster." + }, + "ClusterUpdate": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "sku": { + "$ref": "#/definitions/AzureSku", + "description": "The SKU of the cluster." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The cluster properties.", + "$ref": "#/definitions/ClusterProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "Class representing an update to a Kusto cluster." + }, + "Database": { + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The database properties.", + "$ref": "#/definitions/DatabaseProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Class representing a Kusto database." + }, + "DatabaseUpdate": { + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the updated database.", + "$ref": "#/definitions/DatabaseProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "Class representing an update to a Kusto database." + }, + "DatabasePrincipal": { + "type": "object", + "required": [ + "name", + "role", + "type" + ], + "properties": { + "role": { + "description": "Database principal role.", + "type": "string", + "enum": [ + "Admin", + "Ingestor", + "Monitor", + "User", + "UnrestrictedViewers", + "Viewer" + ], + "x-ms-enum": { + "name": "DatabasePrincipalRole", + "modelAsString": true + } + }, + "name": { + "description": "Database principal name.", + "type": "string" + }, + "type": { + "description": "Database principal type.", + "type": "string", + "enum": [ + "App", + "Group", + "User" + ], + "x-ms-enum": { + "name": "DatabasePrincipalType", + "modelAsString": true + } + }, + "fqn": { + "description": "Database principal fully qualified name.", + "type": "string" + }, + "email": { + "description": "Database principal email if exists.", + "type": "string" + }, + "appId": { + "description": "Application id - relevant only for application principal type.", + "type": "string" + } + }, + "description": "A class representing database principal entity." + }, + "ClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "The list of Kusto clusters." + } + }, + "description": "The list Kusto clusters operation response." + }, + "DatabaseListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "The list of Kusto databases." + } + }, + "description": "The list Kusto databases operation response." + }, + "DatabasePrincipalListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DatabasePrincipal" + }, + "description": "The list of Kusto database principals." + } + }, + "description": "The list Kusto database principals operation response." + }, + "DataConnection": { + "required": [ + "kind" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "kind": { + "description": "Kind of the endpoint for the data connection", + "enum": [ + "EventHub", + "EventGrid" + ], + "type": "string", + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Class representing an data connection.", + "discriminator": "kind" + }, + "DataConnectionValidationResult": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string", + "description": "A message which indicates a problem in data connection validation." + } + }, + "description": "The result returned from a data connection validation request." + }, + "DatabasePrincipalListRequest": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DatabasePrincipal" + }, + "description": "The list of Kusto database principals." + } + }, + "description": "The list Kusto database principals operation request." + }, + "DataConnectionValidation": { + "properties": { + "dataConnectionName": { + "type": "string", + "description": "The name of the data connection." + }, + "properties": { + "$ref": "#/definitions/DataConnection", + "description": "The data connection properties to validate." + } + }, + "description": "Class representing an data connection validation." + }, + "EventHubDataConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The Event Hub data connection properties to validate.", + "$ref": "#/definitions/EventHubConnectionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DataConnection" + } + ], + "description": "Class representing an event hub data connection.", + "x-ms-discriminator-value": "EventHub" + }, + "EventGridDataConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the Event Grid data connection.", + "$ref": "#/definitions/EventGridConnectionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DataConnection" + } + ], + "description": "Class representing an Event Grid data connection.", + "x-ms-discriminator-value": "EventGrid" + }, + "DataConnectionValidationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataConnectionValidationResult" + }, + "description": "The list of Kusto data connection validation errors." + } + }, + "description": "The list Kusto data connection validation result." + }, + "DataConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataConnection" + }, + "description": "The list of Kusto data connections." + } + }, + "description": "The list Kusto data connections operation response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "An error response from Kusto." + } + }, + "description": "An error response from Kusto." + }, + "ClusterCheckNameRequest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cluster name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Kusto/clusters" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Kusto/clusters." + } + }, + "required": [ + "name", + "type" + ], + "description": "The result returned from a cluster check name availability request." + }, + "DatabaseCheckNameRequest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Database name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Kusto/clusters/databases" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Kusto/clusters/databases." + } + }, + "required": [ + "name", + "type" + ], + "description": "The result returned from a database check name availability request." + }, + "CheckNameResult": { + "type": "object", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Specifies a Boolean value that indicates if the name is available." + }, + "name": { + "type": "string", + "description": "The name that was checked." + }, + "message": { + "type": "string", + "description": "Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated." + } + }, + "description": "The result returned from a check name availability request." + }, + "ListResourceSkusResult": { + "description": "List of available SKUs for an existing Kusto Cluster.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { "$ref": "#/definitions/AzureResourceSku" }, + "description": "The collection of available SKUs for an existing resource." + } + } + }, + "ListSkusResult": { + "description": "List of available SKUs for a new Kusto Cluster.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { "$ref": "#/definitions/AzureSku" }, + "description": "The collection of available SKUs for new resources." + } + } + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for displaying in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from Kusto." + }, + "OperationListResult": { + "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "title": "The list of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "title": "The URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "title": "A REST API operation", + "type": "object", + "properties": { + "name": { + "title": "The operation name.", + "description": "This is of the format {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "title": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "The operation type.", + "description": "For example: read, write, delete.", + "type": "string" + }, + "resource": { + "title": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "The friendly name of the operation.", + "type": "string" + } + } + }, + "origin": { + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "title": "Properties of the operation.", + "type": "object", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API Version." + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the Kusto cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group containing the Kusto cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database in the Kusto cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DataConnectionNameParameter": { + "name": "dataConnectionName", + "in": "path", + "description": "The name of the data connection.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "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/azure-kusto/resource-manager/readme.go.md b/specification/azure-kusto/resource-manager/readme.go.md index b0bb13f333c9..014c133476b6 100644 --- a/specification/azure-kusto/resource-manager/readme.go.md +++ b/specification/azure-kusto/resource-manager/readme.go.md @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2018-09-07-preview + - tag: package-2019-01-21 ``` ### Tag: package-2018-09-07-preview and go @@ -24,3 +25,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-01-21' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-01-21/$(namespace) +``` diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md index 4ef174cc472c..f047529f7976 100644 --- a/specification/azure-kusto/resource-manager/readme.md +++ b/specification/azure-kusto/resource-manager/readme.md @@ -28,7 +28,16 @@ These are the global settings for the Kusto API. title: KustoManagementClient description: The Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases. openapi-type: arm -tag: package-2018-09-07-preview +tag: package-2019-01-21 +``` + +### Tag: package-2019-01-21 + +These settings apply only when `--tag=package-2019-01-21` is specified on the command line. + +``` yaml $(tag) == 'package-2019-01-21' +input-file: + - Microsoft.Kusto/stable/2019-01-21/kusto.json ``` ### Tag: package-2018-09-07-preview @@ -49,6 +58,17 @@ input-file: - Microsoft.Kusto/preview/2017-09-07-privatepreview/kusto.json ``` +### Tag: schema-2019-01-21 + +These settings apply only when `--tag=schema-2019-01-21` is specified on the command line. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Kusto\preview\2018-09-07-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'schema-2019-01-21' +input-file: + - Microsoft.Kusto/stable/2019-01-21/kusto.json +``` + ### Tag: schema-2018-09-07-preview These settings apply only when `--tag=schema-2018-09-07-preview` is specified on the command line. @@ -83,6 +103,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-go + - repo: azure-sdk-for-java ``` ## C# @@ -98,3 +119,51 @@ csharp: output-folder: $(csharp-sdks-folder)/Kusto/Management.Kusto/Generated clear-output-folder: true ``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.kusto +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-kusto +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-09-07-preview + - tag: package-2019-01-21 +``` + +### Tag: package-2018-09-07-preview and java + +These settings apply only when `--tag=package-2018-09-07-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-09-07-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.kusto.v2018_09_07_preview + output-folder: $(azure-libraries-for-java-folder)/kusto/resource-manager/v2018_09_07_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2019-01-21 and java + +These settings apply only when `--tag=package-2019-01-21 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2019-01-21' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.kusto.v2019_01_21 + output-folder: $(azure-libraries-for-java-folder)/kusto/resource-manager/v2019_01_21 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json index 665ac345a8a3..eda7d598fea0 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json @@ -11130,7 +11130,7 @@ "storageContainerUrl": { "type": "string", "title": "The URL of the blob container within Azure Blob Storage.", - "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the container, or set the ACL for the container to allow public access." + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, or set the ACL for the container to allow public access." }, "httpUrl": { "type": "string", diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json index fd25da29dade..1a537f8648b6 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json @@ -3401,7 +3401,7 @@ "storageContainerUrl": { "type": "string", "title": "The URL of the blob container within Azure Blob Storage.", - "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access." + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access." }, "httpUrl": { "type": "string", diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/assignmentOperation.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/assignmentOperation.json new file mode 100644 index 000000000000..d202e0591ce5 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/assignmentOperation.json @@ -0,0 +1,322 @@ +{ + "swagger": "2.0", + "info": { + "title": "BlueprintClient", + "description": "Azure Blueprints Client provides access to blueprint definitions, assignments, and artifacts, and related blueprint operations.", + "version": "2018-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}/assignmentOperations": { + "get": { + "tags": [ + "AssignmentOperations" + ], + "operationId": "AssignmentOperations_List", + "description": "List operations for given blueprint assignment within a subscription.", + "x-ms-examples": { + "Assignment": { + "$ref": "./examples/BlueprintAssignmentOperation_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/AssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- all blueprint assignment operations retrieved.", + "schema": { + "$ref": "#/definitions/AssignmentOperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}/assignmentOperations/{assignmentOperationName}": { + "get": { + "tags": [ + "AssignmentOperations" + ], + "operationId": "AssignmentOperations_Get", + "description": "Get a blueprint assignment operation.", + "x-ms-examples": { + "Assignment": { + "$ref": "./examples/BlueprintAssignmentOperation_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/AssignmentNameParameter" + }, + { + "$ref": "#/parameters/AssignmentOperationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- blueprint assignment operation retrieved.", + "schema": { + "$ref": "#/definitions/AssignmentOperation" + } + } + } + } + } + }, + "definitions": { + "AssignmentOperation": { + "type": "object", + "description": "Represents underlying deployment detail for each update to the blueprint assignment.", + "allOf": [ + { "$ref": "#/definitions/AzureResourceBase" } + ], + "properties": { + "properties": { + "description": "Properties for AssignmentOperation.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AssignmentOperationProperties" + } + } + }, + "AssignmentOperationList":{ + "type": "object", + "description": "List of AssignmentOperation.", + "properties": { + "value": { + "type": "array", + "description": "List of AssignmentOperation.", + "items": { + "$ref": "#/definitions/AssignmentOperation" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + + }, + "AssignmentOperationProperties": { + "type": "object", + "description": "Properties of AssignmentOperation.", + "properties": { + "blueprintVersion": { + "type": "string", + "description": "The published version of the blueprint definition used for the blueprint assignment operation." + }, + "assignmentState": { + "type": "string", + "description": "State of this blueprint assignment operation." + }, + "timeCreated": { + "type": "string", + "description": "Create time of this blueprint assignment operation." + }, + "timeStarted": { + "type": "string", + "description": "Start time of the underlying deployment." + }, + "timeFinished": { + "type": "string", + "description": "Finish time of the overall underlying deployments." + }, + "deployments": { + "type": "array", + "description": "List of jobs in this blueprint assignment operation.", + "items": { + "$ref": "#/definitions/AssignmentDeploymentJob" + } + } + } + }, + "AssignmentDeploymentJob": { + "type": "object", + "description": "Represents individual job in given blueprint assignment operation.", + "properties": { + "kind": { + "type": "string", + "description": "Kind of job." + }, + "action": { + "type": "string", + "description": "Name of the action performed in this job." + }, + "jobId": { + "type": "string", + "description": "Id of this job." + }, + "jobState": { + "type": "string", + "description": "State of this job." + }, + "result": { + "description": "Deployment job result.", + "$ref": "#/definitions/AssignmentDeploymentJobResult" + }, + "history": { + "type": "array", + "description": "Result of this deployment job for each retry.", + "items": { + "$ref": "#/definitions/AssignmentDeploymentJobResult" + } + }, + "requestUri": { + "type": "string", + "description": "Reference to deployment job resource id." + } + } + }, + "AssignmentDeploymentJobResult": { + "type": "object", + "description": "Result of each individual deployment in a blueprint assignment.", + "properties": { + "error": { + "description": "Contains error details if deployment job failed.", + "$ref": "#/definitions/AzureResourceManagerError" + }, + "resources": { + "type": "array", + "description": "Resources created as result of the deployment job.", + "items": { + "$ref": "#/definitions/AssignmentJobCreatedResource" + } + } + } + }, + "AssignmentJobCreatedResource": { + "type": "object", + "description": "Azure resource created from deployment job.", + "properties": { + "properties": { + "type": "object", + "description": "Additional properties in a dictionary.", + "additionalProperties": { + "type": "string", + "description": "property value" + } + } + }, + "allOf": [ + { "$ref": "#/definitions/AzureResourceBase" } + ] + }, + + "AzureResourceBase": { + "description": "Common properties for all Azure resources.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "String Id used to locate any resource on Azure." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of this resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of this resource." + } + } + }, + "AzureResourceManagerError": { + "type": "object", + "description": "Error code and message", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + } + + } + } + }, + "parameters": { + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "AssignmentNameParameter": { + "name": "assignmentName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of the blueprint assignment." + }, + "AssignmentOperationNameParameter": { + "name": "assignmentOperationName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of the blueprint assignment operation." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Client API Version." + } + } +} diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json new file mode 100644 index 000000000000..db34be05c81a --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json @@ -0,0 +1,556 @@ +{ + "swagger": "2.0", + "info": { + "title": "BlueprintClient", + "description": "Azure Blueprints Client provides access to blueprint definitions, assignments, and artifacts, and related blueprint operations.", + "version": "2018-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}": { + "put": { + "tags": [ + "Assignment" + ], + "operationId": "Assignments_CreateOrUpdate", + "description": "Create or update a blueprint assignment.", + "x-ms-examples": { + "Assignment": { + "$ref": "./examples/BlueprintAssignment_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/AssignmentNameParameter" + }, + { + "name": "assignment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Assignment" + }, + "description": "Blueprint assignment object to save." + } + ], + "responses": { + "201": { + "description": "Created -- blueprint assignment saved.", + "schema": { + "$ref": "#/definitions/Assignment" + } + } + } + }, + "get": { + "tags": [ + "Assignment" + ], + "operationId": "Assignments_Get", + "description": "Get a blueprint assignment.", + "x-ms-examples": { + "Assignment": { + "$ref": "./examples/BlueprintAssignment_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/AssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- blueprint assignment retrieved.", + "schema": { + "$ref": "#/definitions/Assignment" + } + } + } + }, + "delete": { + "tags": [ + "Assignment" + ], + "operationId": "Assignments_Delete", + "description": "Delete a blueprint assignment.", + "x-ms-examples": { + "Assignment_Delete": { + "$ref": "./examples/BlueprintAssignment_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/AssignmentNameParameter" + } + ], + "responses": { + "202": { + "description": "OK -- blueprint assignment deleted.", + "schema": { + "$ref": "#/definitions/Assignment" + } + }, + "204": { + "description": "No Content" + } + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprintAssignments": { + "get": { + "tags": [ + "Assignment" + ], + "operationId": "Assignments_List", + "description": "List blueprint assignments within a subscription.", + "x-ms-examples": { + "Assignment": { + "$ref": "./examples/BlueprintAssignment_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + } + ], + "responses": { + "200": { + "description": "OK -- all blueprint assignments retrieved.", + "schema": { + "$ref": "#/definitions/AssignmentList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Assignment": { + "type": "object", + "description": "Represents a blueprint assignment.", + "properties": { + "identity": { + "description": "Managed identity for this blueprint assignment.", + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "Properties for blueprint assignment object.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AssignmentProperties" + } + }, + "required": [ + "identity", + "properties" + ], + "allOf": [ + { "$ref": "#/definitions/TrackedResource" } + ] + }, + "AssignmentList": { + "type": "object", + "description": "List of blueprint assignments", + "properties": { + "value": { + "type": "array", + "description": "List of blueprint assignments.", + "items": { + "$ref": "#/definitions/Assignment" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "UserAssignedIdentity": { + "type": "object", + "description": "User-assigned managed identity.", + "properties": { + "principalId": { + "type": "string", + "description": "Azure Active Directory principal ID associated with this Identity." + }, + "clientId": { + "type": "string", + "description": "Client App Id associated with this identity." + } + } + }, + "ManagedServiceIdentity": { + "type": "object", + "description": "Managed identity generic object.", + "properties": { + "type": { + "type": "string", + "description": "Type of the managed identity.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + }, + "principalId": { + "type": "string", + "description": "Azure Active Directory principal ID associated with this Identity." + }, + "tenantId": { + "type": "string", + "description": "ID of the Azure Active Directory." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity.", + "additionalProperties": { + "description": "User-assigned managed identity.", + "$ref": "#/definitions/UserAssignedIdentity" + } + } + }, + "required": [ + "type" + ] + }, + "AssignmentStatus": { + "description": "The status of a blueprint assignment. This field is readonly.", + "type": "object", + "properties": { + }, + "allOf": [ + { "$ref": "#/definitions/BlueprintResourceStatusBase" } + ] + }, + "AssignmentLockSettings": { + "description": "Defines how resources deployed by a blueprint assignment are locked.", + "type": "object", + "properties": { + "mode": { + "type": "string", + "description": "Lock mode.", + "enum": [ + "None", + "AllResources" + ], + "x-ms-enum": { + "name": "AssignmentLockMode", + "modelAsString": true + } + } + } + }, + "AssignmentProperties": { + "type": "object", + "description": "Detailed properties for a blueprint assignment.", + "properties": { + "blueprintId": { + "type": "string", + "description": "ID of the published version of a blueprint definition." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueCollection", + "description": "Blueprint assignment parameter values." + }, + "resourceGroups": { + "$ref": "#/definitions/ResourceGroupValueCollection", + "description": "Names and locations of resource group placeholders." + }, + "status": { + "description": "Status of blueprint assignment. This field is readonly.", + "readOnly": true, + "$ref": "#/definitions/AssignmentStatus" + }, + "locks": { + "description": "Defines how resources deployed by a blueprint assignment are locked.", + "$ref": "#/definitions/AssignmentLockSettings" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "State of the blueprint assignment.", + "enum": [ + "creating", + "validating", + "waiting", + "deploying", + "cancelling", + "locking", + "succeeded", + "failed", + "canceled", + "deleting" + ], + "x-ms-enum": { + "name": "AssignmentProvisioningState", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BlueprintResourcePropertiesBase" + } + ], + "required": [ + "parameters", + "resourceGroups" + ] + }, + "ParameterValueCollection": { + "description": "A dictionary for parameters and their corresponding values.", + "type": "object", + "properties": {}, + "additionalProperties": { + "description": "Key/Value pair of parameter fulfillment.", + "$ref": "#/definitions/ParameterValueBase" + } + }, + "ParameterValueBase": { + "description": "Base class for ParameterValue.", + "type": "object", + "properties": { + "description": { + "description": "Optional property. Establishes ParameterValueBase as a BaseClass.", + "type": "string" + } + } + }, + "ParameterValue": { + "description": "Value for the specified parameter.", + "type": "object", + "properties": { + "value": { + "description": "Actual value." + } + }, + "required": [ "value" ], + "allOf": [ + { "$ref": "#/definitions/ParameterValueBase" } + ] + }, + "SecretReferenceParameterValue": { + "description": "The reference to a secret, if the parameter should be protected.", + "type": "object", + "properties": { + "reference": { + "description": "Specifies the reference.", + "$ref": "#/definitions/SecretValueReference" + } + }, + "required": [ "reference" ], + "allOf": [ + { "$ref": "#/definitions/ParameterValueBase" } + ] + }, + "SecretValueReference": { + "description": "Reference to a Key Vault secret.", + "type": "object", + "properties": { + "keyVault": { + "description": "Specifies the reference to a given Azure Key Vault.", + "$ref": "#/definitions/keyVaultReference" + }, + "secretName": { + "description": "Name of the secret.", + "type": "string" + }, + "secretVersion": { + "description": "If multiple versions, the version of the secret.", + "type": "string" + } + }, + "required": [ + "keyVault", + "secretName" + ] + }, + "keyVaultReference": { + "description": "Specifies the link to a Key Vault.", + "type": "object", + "properties": { + "id": { + "description": "Azure resource ID of the Key Vault.", + "type": "string" + } + }, + "required": [ "id" ] + }, + "ResourceGroupValueCollection": { + "description": "A dictionary which maps resource group placeholders to the resource groups which will be created.", + "type": "object", + "properties": {}, + "additionalProperties": { + "$ref": "#/definitions/ResourceGroupValue" + } + }, + "ResourceGroupValue": { + "description": "Represents an Azure resource group.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource group.", + "minLength": 1, + "maxLength": 90 + }, + "location": { + "type": "string", + "description": "Location of the resource group." + } + } + }, + "TrackedResource": { + "description": "Common properties for all Azure tracked resources.", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of this blueprint assignment.", + "x-ms-mutability": [ "read", "create" ] + } + }, + "required": [ "location" ], + "allOf": [ + { "$ref": "#/definitions/AzureResourceBase" } + ] + }, + "AzureResourceBase": { + "description": "Common properties for all Azure resources.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "String Id used to locate any resource on Azure." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of this resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of this resource." + } + } + }, + "BlueprintResourcePropertiesBase": { + "description": "Shared properties between all blueprint resources.", + "type": "object", + "x-ms-external": true, + "properties": { + "displayName": { + "type": "string", + "description": "One-liner string explain this resource.", + "maxLength": 256 + }, + "description": { + "type": "string", + "description": "Multi-line explain this resource.", + "maxLength": 500 + } + } + }, + "BlueprintResourceStatusBase": { + "description": "Shared status properties between all blueprint resources.", + "type": "object", + "properties": { + "timeCreated": { + "type": "string", + "readOnly": true, + "description": "Creation time of this blueprint definition." + }, + "lastModified": { + "type": "string", + "readOnly": true, + "description": "Last modified time of this blueprint definition." + } + } + } + }, + "parameters": { + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "AssignmentNameParameter": { + "name": "assignmentName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of the blueprint assignment." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Client API Version." + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json new file mode 100644 index 000000000000..38fe28a6dfcb --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json @@ -0,0 +1,1370 @@ +{ + "swagger": "2.0", + "info": { + "title": "BlueprintClient", + "description": "Azure Blueprints Client provides access to blueprint definitions, assignments, and artifacts, and related blueprint operations.", + "version": "2018-11-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}": { + "put": { + "tags": [ + "Blueprint" + ], + "operationId": "Blueprints_CreateOrUpdate", + "description": "Create or update a blueprint definition.", + "x-ms-examples": { + "SubscriptionBlueprint": { + "$ref": "./examples/subscriptionBPDef/Blueprint_Create.json" + }, + "ManagementGroupBlueprint": { + "$ref": "./examples/managementGroupBPDef/Blueprint_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "name": "blueprint", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Blueprint" + }, + "description": "Blueprint definition." + } + ], + "responses": { + "201": { + "description": "Created -- blueprint definition saved.", + "schema": { + "$ref": "#/definitions/Blueprint" + } + } + } + }, + "get": { + "tags": [ + "Blueprint" + ], + "operationId": "Blueprints_Get", + "description": "Get a blueprint definition.", + "x-ms-examples": { + "SubscriptionBlueprint": { + "$ref": "./examples/subscriptionBPDef/Blueprint_Get.json" + }, + "ManagementGroupBlueprint": { + "$ref": "./examples/managementGroupBPDef/Blueprint_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- blueprint definition retrieved.", + "schema": { + "$ref": "#/definitions/Blueprint" + } + } + } + }, + "delete": { + "tags": [ + "Blueprint" + ], + "operationId": "Blueprints_Delete", + "description": "Delete a blueprint definition.", + "x-ms-examples": { + "SubscriptionBlueprint": { + "$ref": "./examples/subscriptionBPDef/Blueprint_Delete.json" + }, + "ManagementGroupBlueprint": { + "$ref": "./examples/managementGroupBPDef/Blueprint_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- blueprint definition deleted.", + "schema": { + "$ref": "#/definitions/Blueprint" + } + }, + "204": { + "description": "No Content" + } + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprints": { + "get": { + "tags": [ + "Blueprint" + ], + "operationId": "Blueprints_List", + "description": "List blueprint definitions.", + "x-ms-examples": { + "SubscriptionBlueprint": { + "$ref": "./examples/subscriptionBPDef/Blueprint_List.json" + }, + "ManagementGroupBlueprint": { + "$ref": "./examples/managementGroupBPDef/Blueprint_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + } + ], + "responses": { + "200": { + "description": "OK -- retrieved list of blueprint definitions.", + "schema": { + "$ref": "#/definitions/BlueprintList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts/{artifactName}": { + "put": { + "tags": [ + "Artifact" + ], + "operationId": "Artifacts_CreateOrUpdate", + "description": "Create or update blueprint artifact.", + "x-ms-examples": { + "Sub-ARMTemplateArtifact": { + "$ref": "./examples/subscriptionBPDef/ARMTemplateArtifact_Create.json" + }, + "Sub-PolicyAssignmentArtifact": { + "$ref": "./examples/subscriptionBPDef/PolicyAssignmentArtifact_Create.json" + }, + "Sub-RoleAssignmentArtifact": { + "$ref": "./examples/subscriptionBPDef/RoleAssignmentArtifact_Create.json" + }, + "MG-ARMTemplateArtifact": { + "$ref": "./examples/managementGroupBPDef/ARMTemplateArtifact_Create.json" + }, + "MG-PolicyAssignmentArtifact": { + "$ref": "./examples/managementGroupBPDef/PolicyAssignmentArtifact_Create.json" + }, + "MG-RoleAssignmentArtifact": { + "$ref": "./examples/managementGroupBPDef/RoleAssignmentArtifact_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "$ref": "#/parameters/ArtifactNameParameter" + }, + { + "name": "artifact", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Artifact" + }, + "description": "Blueprint artifact to create or update." + } + ], + "responses": { + "201": { + "description": "Created -- blueprint artifact created/updated.", + "schema": { + "$ref": "#/definitions/Artifact" + } + } + } + }, + "get": { + "tags": [ + "Artifact" + ], + "operationId": "Artifacts_Get", + "description": "Get a blueprint artifact.", + "x-ms-examples": { + "Sub-ARMTemplateArtifact": { + "$ref": "./examples/subscriptionBPDef/ARMTemplateArtifact_Get.json" + }, + "Sub-PolicyAssignmentArtifact": { + "$ref": "./examples/subscriptionBPDef/PolicyAssignmentArtifact_Get.json" + }, + "Sub-RoleAssignmentArtifact": { + "$ref": "./examples/subscriptionBPDef/RoleAssignmentArtifact_Get.json" + }, + "MG-ARMTemplateArtifact": { + "$ref": "./examples/managementGroupBPDef/ARMTemplateArtifact_Get.json" + }, + "MG-PolicyAssignmentArtifact": { + "$ref": "./examples/managementGroupBPDef/PolicyAssignmentArtifact_Get.json" + }, + "MG-RoleAssignmentArtifact": { + "$ref": "./examples/managementGroupBPDef/RoleAssignmentArtifact_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "$ref": "#/parameters/ArtifactNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- blueprint artifact retrieved.", + "schema": { + "$ref": "#/definitions/Artifact" + } + } + } + }, + "delete": { + "tags": [ + "Artifact" + ], + "operationId": "Artifacts_Delete", + "description": "Delete a blueprint artifact.", + "x-ms-examples": { + "Sub-ARMTemplateArtifact": { + "$ref": "./examples/subscriptionBPDef/ARMTemplateArtifact_Delete.json" + }, + "Sub-PolicyAssignmentArtifact": { + "$ref": "./examples/subscriptionBPDef/PolicyAssignmentArtifact_Delete.json" + }, + "Sub-RoleAssignmentArtifact": { + "$ref": "./examples/subscriptionBPDef/RoleAssignmentArtifact_Delete.json" + }, + "MG-ARMTemplateArtifact": { + "$ref": "./examples/managementGroupBPDef/ARMTemplateArtifact_Delete.json" + }, + "MG-PolicyAssignmentArtifact": { + "$ref": "./examples/managementGroupBPDef/PolicyAssignmentArtifact_Delete.json" + }, + "MG-RoleAssignmentArtifact": { + "$ref": "./examples/managementGroupBPDef/RoleAssignmentArtifact_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "$ref": "#/parameters/ArtifactNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- blueprint artifact deleted.", + "schema": { + "$ref": "#/definitions/Artifact" + } + }, + "204": { + "description": "No Content" + } + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/artifacts": { + "get": { + "tags": [ + "Artifact" + ], + "operationId": "Artifacts_List", + "description": "List artifacts for a given blueprint definition.", + "x-ms-examples": { + "Sub-ArtifactList": { + "$ref": "./examples/subscriptionBPDef/Artifact_List.json" + }, + "MG-ArtifactList": { + "$ref": "./examples/managementGroupBPDef/Artifact_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- blueprint artifacts retrieved.", + "schema": { + "$ref": "#/definitions/ArtifactList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}": { + "put": { + "tags": [ + "PublishedBlueprint" + ], + "operationId": "PublishedBlueprints_Create", + "description": "Publish a new version of the blueprint definition with the latest artifacts. Published blueprint definitions are immutable.", + "x-ms-examples": { + "PublishedSubscriptionBlueprint_Publish": { + "$ref": "./examples/subscriptionBPDef/SealedBlueprint_Publish.json" + }, + "PublishedManagementGroupBlueprint_Publish": { + "$ref": "./examples/managementGroupBPDef/SealedBlueprint_Publish.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "$ref": "#/parameters/PublishedBlueprintVersionIdParameter" + } + ], + "responses": { + "201": { + "description": "Created -- blueprint definition published.", + "schema": { + "$ref": "#/definitions/PublishedBlueprint" + } + } + } + }, + "get": { + "tags": [ + "PublishedBlueprint" + ], + "operationId": "PublishedBlueprints_Get", + "description": "Get a published version of a blueprint definition.", + "x-ms-examples": { + "PublishedSubscriptionBlueprint": { + "$ref": "./examples/subscriptionBPDef/SealedBlueprint_Get.json" + }, + "PublishedManagementGroupBlueprint": { + "$ref": "./examples/managementGroupBPDef/SealedBlueprint_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "$ref": "#/parameters/PublishedBlueprintVersionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- published blueprint definition retrieved.", + "schema": { + "$ref": "#/definitions/PublishedBlueprint" + } + } + } + }, + "delete": { + "tags": [ + "PublishedBlueprint" + ], + "operationId": "PublishedBlueprints_Delete", + "description": "Delete a published version of a blueprint definition.", + "x-ms-examples": { + "PublishedSubscriptionBlueprint": { + "$ref": "./examples/subscriptionBPDef/SealedBlueprint_Delete.json" + }, + "PublishedManagementGroupBlueprint": { + "$ref": "./examples/managementGroupBPDef/SealedBlueprint_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "$ref": "#/parameters/PublishedBlueprintVersionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- published version of blueprint definition deleted.", + "schema": { + "$ref": "#/definitions/PublishedBlueprint" + } + }, + "204": { + "description": "No Content" + } + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions": { + "get": { + "tags": [ + "PublishedBlueprint" + ], + "operationId": "PublishedBlueprints_List", + "description": "List published versions of given blueprint definition.", + "x-ms-examples": { + "PublishedSubscriptionBlueprint": { + "$ref": "./examples/subscriptionBPDef/SealedBlueprint_List.json" + }, + "PublishedManagementGroupBlueprint": { + "$ref": "./examples/managementGroupBPDef/SealedBlueprint_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- all published versions of blueprint definition retrieved.", + "schema": { + "$ref": "#/definitions/PublishedBlueprintList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}/artifacts/{artifactName}": { + "get": { + "tags": [ + "PublishedArtifact" + ], + "operationId": "PublishedArtifacts_Get", + "description": "Get an artifact for a published blueprint definition.", + "x-ms-examples": { + "Sub-ARMTemplateArtifact": { + "$ref": "./examples/subscriptionBPDef/ARMTemplateArtifact_Get.json" + }, + "Sub-PolicyAssignmentArtifact": { + "$ref": "./examples/subscriptionBPDef/PolicyAssignmentArtifact_Get.json" + }, + "Sub-RoleAssignmentArtifact": { + "$ref": "./examples/subscriptionBPDef/RoleAssignmentArtifact_Get.json" + }, + "MG-ARMTemplateArtifact": { + "$ref": "./examples/managementGroupBPDef/ARMTemplateArtifact_Get.json" + }, + "MG-PolicyAssignmentArtifact": { + "$ref": "./examples/managementGroupBPDef/PolicyAssignmentArtifact_Get.json" + }, + "MG-RoleAssignmentArtifact": { + "$ref": "./examples/managementGroupBPDef/RoleAssignmentArtifact_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "$ref": "#/parameters/PublishedBlueprintVersionIdParameter" + }, + { + "$ref": "#/parameters/ArtifactNameParameter" + } + ], + "responses": { + "200": { + "description": "OK -- artifact of published blueprint definition retrieved.", + "schema": { + "$ref": "#/definitions/Artifact" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}/versions/{versionId}/artifacts": { + "get": { + "tags": [ + "PublishedArtifact" + ], + "operationId": "PublishedArtifacts_List", + "description": "List artifacts for a version of a published blueprint definition.", + "x-ms-examples": { + "Sub-ArtifactList": { + "$ref": "./examples/subscriptionBPDef/SealedArtifact_List.json" + }, + "MG-ArtifactList": { + "$ref": "./examples/managementGroupBPDef/SealedArtifact_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/BlueprintNameParameter" + }, + { + "$ref": "#/parameters/PublishedBlueprintVersionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- artifacts of a version of published blueprint definition retrieved.", + "schema": { + "$ref": "#/definitions/ArtifactList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Blueprint": { + "type": "object", + "description": "Represents a Blueprint definition.", + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for blueprint definition.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BlueprintProperties" + } + }, + "required": [ + "properties" + ] + }, + "Artifact": { + "type": "object", + "discriminator": "kind", + "description": "Represents a blueprint artifact.", + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ], + "properties": { + "kind": { + "type": "string", + "description": "Specifies the kind of blueprint artifact.", + "enum": [ + "template", + "roleAssignment", + "policyAssignment" + ], + "x-ms-enum": { + "name": "ArtifactKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ] + }, + "PublishedBlueprint": { + "type": "object", + "description": "Represents a published blueprint.", + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ], + "properties": { + "properties": { + "description": "Detailed properties for published blueprint.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublishedBlueprintProperties" + } + }, + "required": [ + "properties" + ] + }, + "BlueprintList": { + "type": "object", + "title": "BlueprintList", + "description": "List of blueprint definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of blueprint definitions.", + "items": { + "$ref": "#/definitions/Blueprint" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "PublishedBlueprintList": { + "type": "object", + "title": "BlueprintList", + "description": "List of published blueprint definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of published blueprint definitions.", + "items": { + "$ref": "#/definitions/PublishedBlueprint" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ArtifactList": { + "type": "object", + "description": "List of blueprint artifacts.", + "properties": { + "value": { + "type": "array", + "description": "List of blueprint artifacts.", + "items": { + "$ref": "#/definitions/Artifact" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ResourceProviderOperationList": { + "description": "Results of the request to list operations.", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "description": "List of operations supported by this resource provider." + } + } + }, + "ResourceProviderOperation": { + "description": "Supported operations of this resource provider.", + "readOnly": true, + "properties": { + "name": { + "description": "Operation name, in format of {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Resource provider: Microsoft Blueprint.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of this operation.", + "type": "string" + } + } + } + } + }, + "SharedBlueprintProperties": { + "description": "Shared Schema for both blueprintProperties and publishedBlueprintProperties.", + "type": "object", + "x-ms-external": true, + "properties": { + "status": { + "description": "Status of the blueprint. This field is readonly.", + "readOnly": true, + "$ref": "#/definitions/BlueprintStatus" + }, + "targetScope": { + "type": "string", + "description": "The scope where this blueprint definition can be assigned.", + "enum": [ + "subscription", + "managementGroup" + ], + "x-ms-enum": { + "name": "BlueprintTargetScope", + "modelAsString": true + } + }, + "parameters": { + "description": "Parameters required by this blueprint definition.", + "$ref": "#/definitions/ParameterDefinitionCollection" + }, + "resourceGroups": { + "description": "Resource group placeholders defined by this blueprint definition.", + "$ref": "#/definitions/ResourceGroupDefinitionCollection" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BlueprintResourcePropertiesBase" + } + ] + }, + "BlueprintProperties": { + "description": "Schema for blueprint definition properties.", + "type": "object", + "x-ms-external": true, + "allOf": [ + { "$ref": "#/definitions/SharedBlueprintProperties" } + ], + "properties": { + "versions": { + "type": "object", + "description": "Published versions of this blueprint definition." + }, + "layout": { + "type": "object", + "description": "Layout view of the blueprint definition for UI reference." + } + }, + "required": [ + "targetScope" + ] + }, + "PublishedBlueprintProperties": { + "description": "Schema for published blueprint definition properties.", + "type": "object", + "x-ms-external": true, + "allOf": [ + { "$ref": "#/definitions/SharedBlueprintProperties" } + ], + "properties": { + "blueprintName": { + "description": "Name of the published blueprint definition.", + "type": "string" + }, + "changeNotes": { + "description": "Version-specific change notes.", + "type": "string", + "maxLength": 500 + } + } + }, + "BlueprintStatus": { + "description": "The status of the blueprint. This field is readonly.", + "type": "object", + "properties": { + }, + "allOf": [ + { "$ref": "#/definitions/BlueprintResourceStatusBase" } + ] + }, + "TemplateArtifactProperties": { + "type": "object", + "description": "Properties of a Resource Manager template blueprint artifact.", + "properties": { + "template": { + "type": "object", + "description": "The Resource Manager template blueprint artifact body." + }, + "resourceGroup": { + "type": "string", + "description": "If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed." + }, + "parameters": { + "description": "Resource Manager template blueprint artifact parameter values.", + "$ref": "#/definitions/ParameterValueCollection" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BlueprintResourcePropertiesBase" + }, + { + "$ref": "#/definitions/ArtifactPropertiesBase" + } + ], + "required": [ + "template", + "parameters" + ] + }, + "TemplateArtifact": { + "description": "Blueprint artifact that deploys a Resource Manager template.", + "type": "object", + "x-ms-discriminator-value": "template", + "properties": { + "properties": { + "description": "Properties for a Resource Manager template blueprint artifact.", + "$ref": "#/definitions/TemplateArtifactProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Artifact" + } + ], + "required": [ + "properties" + ] + }, + "RoleAssignmentArtifactProperties": { + "type": "object", + "description": "Properties of a Role assignment blueprint artifact.", + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "Azure resource ID of the RoleDefinition." + }, + "principalIds": { + "description": "Array of user or group identities in Azure Active Directory. The roleDefinition will apply to each identity." + }, + "resourceGroup": { + "type": "string", + "description": "RoleAssignment will be scope to this resourceGroup. If empty, it scopes to the subscription." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BlueprintResourcePropertiesBase" + }, + { + "$ref": "#/definitions/ArtifactPropertiesBase" + } + ], + "required": [ + "roleDefinitionId", + "principalIds" + ] + }, + "RoleAssignmentArtifact": { + "description": "Blueprint artifact that applies a Role assignment.", + "type": "object", + "x-ms-discriminator-value": "roleAssignment", + "properties": { + "properties": { + "description": "Properties for a Role assignment blueprint artifact.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentArtifactProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Artifact" + } + ], + "required": [ + "properties" + ] + }, + "PolicyAssignmentArtifactProperties": { + "type": "object", + "description": "Properties of a Policy assignment blueprint artifact.", + "properties": { + "policyDefinitionId": { + "type": "string", + "description": "Azure resource ID of the policy definition." + }, + "parameters": { + "description": "Parameter values for the policy definition.", + "$ref": "#/definitions/ParameterValueCollection" + }, + "resourceGroup": { + "type": "string", + "description": "Name of the resource group placeholder to which the policy will be assigned." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BlueprintResourcePropertiesBase" + }, + { + "$ref": "#/definitions/ArtifactPropertiesBase" + } + ], + "required": [ + "policyDefinitionId", + "parameters" + ] + }, + "PolicyAssignmentArtifact": { + "description": "Blueprint artifact that applies a Policy assignment.", + "type": "object", + "x-ms-discriminator-value": "policyAssignment", + "properties": { + "properties": { + "description": "properties for policyAssignment Artifact", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyAssignmentArtifactProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Artifact" + } + ], + "required": [ + "properties" + ] + }, + "ParameterValueCollection": { + "description": "A dictionary for parameters and their corresponding values.", + "type": "object", + "properties": {}, + "additionalProperties": { + "description": "Key/Value pair of parameter fulfillment.", + "$ref": "#/definitions/ParameterValueBase" + } + }, + "ParameterValueBase": { + "description": "Base class for ParameterValue.", + "type": "object", + "properties": { + "description": { + "description": "Optional property. Establishes ParameterValueBase as a BaseClass.", + "type": "string" + } + } + }, + "ParameterValue": { + "description": "Value for the specified parameter.", + "type": "object", + "properties": { + "value": { + "description": "Actual value." + } + }, + "required": [ "value" ], + "allOf": [ + { "$ref": "#/definitions/ParameterValueBase" } + ] + }, + "SecretReferenceParameterValue": { + "description": "The reference to a secret, if the parameter should be protected.", + "type": "object", + "properties": { + "reference": { + "description": "Specifies the reference.", + "$ref": "#/definitions/SecretValueReference" + } + }, + "required": [ "reference" ], + "allOf": [ + { "$ref": "#/definitions/ParameterValueBase" } + ] + }, + "SecretValueReference": { + "description": "Reference to a Key Vault secret.", + "type": "object", + "properties": { + "keyVault": { + "description": "Specifies the reference to a given Azure Key Vault.", + "$ref": "#/definitions/keyVaultReference" + }, + "secretName": { + "description": "Name of the secret.", + "type": "string" + }, + "secretVersion": { + "description": "If multiple versions, the version of the secret.", + "type": "string" + } + }, + "required": [ + "keyVault", + "secretName" + ] + }, + "keyVaultReference": { + "description": "Specifies the link to a Key Vault.", + "type": "object", + "properties": { + "id": { + "description": "Azure resource ID of the Key Vault.", + "type": "string" + } + }, + "required": [ "id" ] + }, + "ParameterDefinitionCollection": { + "description": "A dictionary hold parameter name and its metadata.", + "type": "object", + "properties": {}, + "additionalProperties": { + "description": "Named collection of parameter metadata.", + "$ref": "#/definitions/ParameterDefinition" + } + }, + "ParameterDefinition": { + "description": "Represent a parameter with constrains and metadata.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Allowed data types for Resource Manager template parameters.", + "enum": [ + "string", + "array", + "bool", + "int", + "object", + "secureObject", + "secureString" + ], + "x-ms-enum": { + "name": "TemplateParameterType", + "modelAsString": true + } + }, + "metadata": { + "description": "User-friendly properties for this parameter.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ParameterDefinitionMetadata" + }, + "defaultValue": { + "description": "Default Value for this parameter." + }, + "allowedValues": { + "type": "array", + "description": "Array of allowed values for this parameter.", + "items": { + "description": "Allowed value." + } + } + }, + "required": [ + "type" + ] + }, + "ResourceGroupDefinitionCollection": { + "description": "A dictionary which maps resource group placeholders to the resource groups which will be created.", + "type": "object", + "properties": {}, + "additionalProperties": { + "description": "Named collection for resourceGroupDefinition.", + "$ref": "#/definitions/ResourceGroupDefinition" + } + }, + "ResourceGroupDefinition": { + "description": "Represents an Azure resource group in a blueprint definition.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment.", + "minLength": 1, + "maxLength": 90 + }, + "location": { + "type": "string", + "description": "Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment.", + "maxLength": 90 + }, + "metadata": { + "description": "User-friendly properties for this resource group.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ParameterDefinitionMetadata" + }, + "dependsOn": { + "type": "array", + "description": "Artifacts which need to be deployed before this resource group.", + "items": { + "type": "string", + "description": "Name of peer artifact." + } + } + } + }, + "ParameterDefinitionMetadata": { + "type": "object", + "description": "User-friendly properties for this parameter.", + "properties": { + "displayName": { + "type": "string", + "description": "DisplayName of this parameter/resourceGroup.", + "maxLength": 256 + }, + "description": { + "type": "string", + "description": "Description of this parameter/resourceGroup.", + "maxLength": 500 + }, + "strongType": { + "type": "string", + "description": "StrongType for UI to render rich experience during blueprint assignment.", + "maxLength": 64 + } + } + }, + "ResourceGroupValueCollection": { + "description": "A dictionary which maps resource group placeholders to the resource groups which will be created.", + "type": "object", + "properties": {}, + "additionalProperties": { + "$ref": "#/definitions/ResourceGroupValue" + } + }, + "ResourceGroupValue": { + "description": "Represents an Azure resource group.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource group.", + "minLength": 1, + "maxLength": 90 + }, + "location": { + "type": "string", + "description": "Location of the resource group." + } + } + }, + "AzureResourceBase": { + "description": "Common properties for all Azure resources.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "String Id used to locate any resource on Azure." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of this resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of this resource." + } + } + }, + "ArtifactPropertiesBase": { + "description": "Common properties shared by different artifacts.", + "type": "object", + "x-ms-external": true, + "properties": { + "dependsOn": { + "type": "array", + "description": "Artifacts which need to be deployed before the specified artifact.", + "items": { + "type": "string", + "description": "ID of peer artifact." + } + } + } + }, + "BlueprintResourcePropertiesBase": { + "description": "Shared properties between all blueprint resources.", + "type": "object", + "x-ms-external": true, + "properties": { + "displayName": { + "type": "string", + "description": "One-liner string explain this resource.", + "maxLength": 256 + }, + "description": { + "type": "string", + "description": "Multi-line explain this resource.", + "maxLength": 500 + } + } + }, + "BlueprintResourceStatusBase": { + "description": "Shared status properties between all blueprint resources.", + "type": "object", + "properties": { + "timeCreated": { + "type": "string", + "readOnly": true, + "description": "Creation time of this blueprint definition." + }, + "lastModified": { + "type": "string", + "readOnly": true, + "description": "Last modified time of this blueprint definition." + } + } + } + }, + "parameters": { + "ScopeParameter":{ + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the resource. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: '/subscriptions/{subscriptionId}').", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "BlueprintNameParameter": { + "name": "blueprintName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of the blueprint definition." + }, + "ArtifactNameParameter": { + "name": "artifactName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of the blueprint artifact." + }, + "PublishedBlueprintVersionIdParameter": { + "name": "versionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Version of the published blueprint definition." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Client API Version." + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_Get.json new file mode 100644 index 000000000000..3a6c0b507eca --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_Get.json @@ -0,0 +1,49 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "assignmentName":"assignSimpleBlueprint", + "assignmentOperationName":"fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f" + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/microsoft.blueprint/blueprintAssignments/assignSimpleBlueprint/assignmentOperations/fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f", + "type": "microsoft.blueprint/blueprintAssignments/operations", + "name": "fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f", + "properties": { + "blueprintVersion": "v20181101", + "assignmentState": "succeed", + "timeCreated": "2018-11-13T15:19:45-08:00", + "timeStarted": "2018-11-13T15:21:49-08:00", + "timeFinished": "2018-11-13T15:26:02-08:00", + "deployments":[ + { + "kind": "azureResource", + "action": "put", + "jobState": "succeeded", + "requestUri": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/microsoft.deployments/deployments/48432786-2f1b-4925-8032-a5d57bcb5b6e", + "result": { + "resources": [ + { + "id": "blabla", + "name":"foobar", + "type":"foo/bar" + } + ] + }, + "history":[ + { + "error":{ + "code": "dummy", + "message":"dummy" + } + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_List.json new file mode 100644 index 000000000000..040bc621dc99 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignmentOperation_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "assignmentName": "assignSimpleBlueprint" + }, + "responses": { + "200": { + "body": { + "value":[{ + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/microsoft.blueprint/blueprintAssignments/assignSimpleBlueprint/assignmentOperations/fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f", + "type": "microsoft.blueprint/blueprintAssignments/operations", + "name": "fb5d4dcb-7ce2-4087-ba7a-459aa74e5e0f", + "properties": { + "blueprintVersion": "v20181101", + "assignmentState": "succeed", + "timeCreated": "2018-11-13T15:19:45-08:00", + "timeStarted": "2018-11-13T15:21:49-08:00", + "timeFinished": "2018-11-13T15:26:02-08:00", + "deployments": [ + { + "kind": "azureResource", + "action": "put", + "jobState": "succeeded", + "requestUri": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/microsoft.deployments/deployments/48432786-2f1b-4925-8032-a5d57bcb5b6e", + "result": { + "resources": [ + { + "id": "blabla", + "name": "foobar", + "type": "foo/bar" + } + ] + }, + "history": [ + { + "error": { + "code": "dummy", + "message": "dummy" + } + } + ] + } + ] + } + }], + "nextLink":null + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Create.json new file mode 100644 index 000000000000..9b140c307da4 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Create.json @@ -0,0 +1,77 @@ +{ + "parameters":{ + "api-version":"2017-11-11-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "assignmentName":"assignSimpleBlueprint", + "assignment":{ + "identity":{ + "type": "SystemAssigned" + }, + "location": "eastus", + "properties": { + "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.", + "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "parameters": { + "storageAccountType": { + "value": "Standard_LRS" + }, + "costCenter": { + "value": "Contoso/Online/Shopping/Production" + }, + "owners": { + "value": [ + "johnDoe@contoso.com", + "johnsteam@contoso.com" + ] + } + }, + "resourceGroups": { + "storageRG": { + "name": "defaultRG", + "location": "eastus" + } + } + } + } + }, + "responses":{ + "201":{ + "body":{ + "identity":{ + "type": "SystemAssigned", + "tenantId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "properties": { + "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.", + "provisioningState": "creating", + "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "parameters": { + "storageAccountType": { + "value": "Standard_LRS" + }, + "costCenter": { + "value": "Contoso/Online/Shopping/Production" + }, + "owners": { + "value": [ + "johnDoe@contoso.com", + "johnsteam@contoso.com" + ] + } + }, + "resourceGroups": { + "storageRG": { + "name": "defaultRG", + "location": "eastus" + } + } + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint", + "type": "Microsoft.Blueprint/Assignment", + "name": "assignSimpleBlueprint" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Delete.json new file mode 100644 index 000000000000..6b2bb85879a5 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Delete.json @@ -0,0 +1,48 @@ +{ + "parameters":{ + "api-version":"2017-11-11-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "assignmentName":"assignSimpleBlueprint" + }, + "responses":{ + "202":{ + "body":{ + "identity":{ + "type": "SystemAssigned", + "tenantId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "properties": { + "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.", + "provisioningState": "deleting", + "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "parameters": { + "storageAccountType": { + "value": "Standard_LRS" + }, + "costCenter": { + "value": "Contoso/Online/Shopping/Production" + }, + "owners": { + "value": [ + "johnDoe@contoso.com", + "johnsteam@contoso.com" + ] + } + }, + "resourceGroups": { + "storageRG": { + "name": "defaultRG", + "location": "eastus" + } + } + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint", + "type": "Microsoft.Blueprint/Assignment", + "name": "assignSimpleBlueprint" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Get.json new file mode 100644 index 000000000000..1d1f5e06054a --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_Get.json @@ -0,0 +1,47 @@ +{ + "parameters":{ + "api-version":"2017-11-11-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "assignmentName":"assignSimpleBlueprint" + }, + "responses":{ + "200":{ + "body":{ + "identity":{ + "type": "SystemAssigned", + "tenantId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "properties": { + "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.", + "provisioningState": "succeed", + "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "parameters": { + "storageAccountType": { + "value": "Standard_LRS" + }, + "costCenter": { + "value": "Contoso/Online/Shopping/Production" + }, + "owners": { + "value": [ + "johnDoe@contoso.com", + "johnsteam@contoso.com" + ] + } + }, + "resourceGroups": { + "storageRG": { + "name": "defaultRG", + "location": "eastus" + } + } + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint", + "type": "Microsoft.Blueprint/Assignment", + "name": "assignSimpleBlueprint" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_List.json new file mode 100644 index 000000000000..1cb07a7dcd6d --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/BlueprintAssignment_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version":"2017-11-11-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity":{ + "type": "SystemAssigned", + "tenantId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "properties": { + "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.", + "provisioningState": "failed", + "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "parameters": { + "storageAccountType": { + "value": "Standard_LRS" + }, + "costCenter": { + "value": "Contoso/Online/Shopping/Production" + }, + "owners": { + "value": [ + "johnDoe@contoso.com", + "johnsteam@contoso.com" + ] + } + }, + "resourceGroups": { + "storageRG": { + "name": "defaultRG", + "location": "eastus" + } + } + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint", + "type": "Microsoft.Blueprint/Assignment", + "name": "assignSimpleBlueprint" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Create.json new file mode 100644 index 000000000000..e560785ca8f7 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Create.json @@ -0,0 +1,117 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "storageTemplate", + "artifact":{ + "kind": "template", + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + } + } + }, + "responses":{ + "201":{ + "body":{ + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "storageTemplate" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Delete.json new file mode 100644 index 000000000000..1406b77205f3 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Delete.json @@ -0,0 +1,67 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "storageTemplate" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "storageTemplate" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Get.json new file mode 100644 index 000000000000..11328862142e --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/ARMTemplateArtifact_Get.json @@ -0,0 +1,66 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "storageTemplate" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "storageTemplate" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Artifact_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Artifact_List.json new file mode 100644 index 000000000000..b1057dead343 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Artifact_List.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "ownerAssignment" + }, + { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "costCenterPolicy" + }, + { + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "storageTemplate" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Create.json new file mode 100644 index 000000000000..6155ea5f752c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Create.json @@ -0,0 +1,85 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "blueprint":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + } + } + }, + "responses":{ + "201":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type.", + "description": null + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription.", + "description": null + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment.", + "description": null + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + }, + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints", + "name": "simpleBlueprint" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Delete.json new file mode 100644 index 000000000000..b0fddc400575 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Delete.json @@ -0,0 +1,50 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription", + "status": null + }, + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints", + "name": "simpleBlueprint" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Get.json new file mode 100644 index 000000000000..1b41b5fa716a --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_Get.json @@ -0,0 +1,49 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription", + "status": null + }, + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints", + "name": "simpleBlueprint" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_List.json new file mode 100644 index 000000000000..8c1ebdfe3475 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/Blueprint_List.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription", + "status": null + }, + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints", + "name": "simpleBlueprint" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Create.json new file mode 100644 index 000000000000..ae0f1482570f --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Create.json @@ -0,0 +1,37 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "costCenterPolicy", + "artifact":{ + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment" + } + }, + "responses":{ + "201":{ + "body": { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "costCenterPolicy" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Delete.json new file mode 100644 index 000000000000..e6b6120c0d8c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Delete.json @@ -0,0 +1,27 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "costCenterPolicy" + }, + "responses":{ + "200":{ + "body": { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "costCenterPolicy" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Get.json new file mode 100644 index 000000000000..1f50fdf33866 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/PolicyAssignmentArtifact_Get.json @@ -0,0 +1,26 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "costCenterPolicy" + }, + "responses":{ + "200":{ + "body": { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "costCenterPolicy" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Create.json new file mode 100644 index 000000000000..c3bf4529d966 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Create.json @@ -0,0 +1,31 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "ownerAssignment", + "artifact":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment" + } + }, + "responses":{ + "201":{ + "body":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "ownerAssignment" + } + } + } +} diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Delete.json new file mode 100644 index 000000000000..322ab102b875 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "ownerAssignment" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "ownerAssignment" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Get.json new file mode 100644 index 000000000000..b66f195308bc --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/RoleAssignmentArtifact_Get.json @@ -0,0 +1,23 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "artifactName": "ownerAssignment" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "ownerAssignment" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedARMTemplateArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedARMTemplateArtifact_Get.json new file mode 100644 index 000000000000..a0a022a7db01 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedARMTemplateArtifact_Get.json @@ -0,0 +1,67 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "versionId":"V2", + "artifactName": "storageTemplate" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "storageTemplate" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedArtifact_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedArtifact_List.json new file mode 100644 index 000000000000..341c5304e9b2 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedArtifact_List.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "versionId": "V2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "ownerAssignment" + }, + { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "costCenterPolicy" + }, + { + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "storageTemplate" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Delete.json new file mode 100644 index 000000000000..e502efe08429 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Delete.json @@ -0,0 +1,54 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "versionId": "v2" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "blueprintName":"simpleBlueprint", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type.", + "description": null + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription.", + "description": null + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment.", + "description": null + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + }, + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints/versions", + "name": "v2" + } + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Get.json new file mode 100644 index 000000000000..1d3618dd43f7 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Get.json @@ -0,0 +1,53 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "versionId": "v2" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "blueprintName":"simpleBlueprint", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type.", + "description": null + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription.", + "description": null + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment.", + "description": null + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + }, + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints/versions", + "name": "v2" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_List.json new file mode 100644 index 000000000000..9238f5621f01 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_List.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName": "simpleBlueprint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "blueprintName": "simpleBlueprint", + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription", + "status": null + }, + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/v1", + "type": "Microsoft.Blueprint/blueprints/versions", + "name": "v1" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Publish.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Publish.json new file mode 100644 index 000000000000..e5a72160fecc --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedBlueprint_Publish.json @@ -0,0 +1,53 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "versionId": "v2" + }, + "responses":{ + "201":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "blueprintName":"simpleBlueprint", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type.", + "description": null + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription.", + "description": null + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment.", + "description": null + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + }, + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints/versions", + "name": "v2" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedPolicyAssignmentArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedPolicyAssignmentArtifact_Get.json new file mode 100644 index 000000000000..6c7ddcac8fd2 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedPolicyAssignmentArtifact_Get.json @@ -0,0 +1,27 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "versionId":"V2", + "artifactName": "costCenterPolicy" + }, + "responses":{ + "200":{ + "body": { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "costCenterPolicy" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedRoleAssignmentArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedRoleAssignmentArtifact_Get.json new file mode 100644 index 000000000000..18ae13b1b62c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPDef/SealedRoleAssignmentArtifact_Get.json @@ -0,0 +1,24 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"providers/Microsoft.Management/managementGroups/ContosoOnlineGroup", + "blueprintName":"simpleBlueprint", + "versionId":"V2", + "artifactName": "ownerAssignment" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "ownerAssignment" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Create.json new file mode 100644 index 000000000000..5c7ed4abb3dd --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Create.json @@ -0,0 +1,117 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "storageTemplate", + "artifact":{ + "kind": "template", + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + } + } + }, + "responses":{ + "201":{ + "body":{ + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "storageTemplate" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Delete.json new file mode 100644 index 000000000000..679ff9cd5a5c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Delete.json @@ -0,0 +1,67 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "storageTemplate" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "storageTemplate" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Get.json new file mode 100644 index 000000000000..6f82f380d90e --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/ARMTemplateArtifact_Get.json @@ -0,0 +1,66 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "storageTemplate" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "storageTemplate" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Artifact_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Artifact_List.json new file mode 100644 index 000000000000..9bf40050ffb2 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Artifact_List.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "ownerAssignment" + }, + { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "costCenterPolicy" + }, + { + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "storageTemplate" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Create.json new file mode 100644 index 000000000000..73134ab2e9ae --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Create.json @@ -0,0 +1,85 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "blueprint":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + } + } + }, + "responses":{ + "201":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type.", + "description": null + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription.", + "description": null + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment.", + "description": null + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints", + "name": "simpleBlueprint" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Delete.json new file mode 100644 index 000000000000..81020eb24f55 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Delete.json @@ -0,0 +1,50 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription", + "status": null + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints", + "name": "simpleBlueprint" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Get.json new file mode 100644 index 000000000000..f7d1ffaa3730 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_Get.json @@ -0,0 +1,49 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription", + "status": null + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints", + "name": "simpleBlueprint" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_List.json new file mode 100644 index 000000000000..55a531a09331 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/Blueprint_List.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription", + "status": null + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints", + "name": "simpleBlueprint" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Create.json new file mode 100644 index 000000000000..cd1501ec5f6c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Create.json @@ -0,0 +1,37 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "costCenterPolicy", + "artifact":{ + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment" + } + }, + "responses":{ + "201":{ + "body": { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "costCenterPolicy" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Delete.json new file mode 100644 index 000000000000..959156266eda --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Delete.json @@ -0,0 +1,27 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "costCenterPolicy" + }, + "responses":{ + "200":{ + "body": { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "costCenterPolicy" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Get.json new file mode 100644 index 000000000000..3773dc72c8e2 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/PolicyAssignmentArtifact_Get.json @@ -0,0 +1,26 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "costCenterPolicy" + }, + "responses":{ + "200":{ + "body": { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "costCenterPolicy" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Create.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Create.json new file mode 100644 index 000000000000..468b98798c6c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Create.json @@ -0,0 +1,31 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "ownerAssignment", + "artifact":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment" + } + }, + "responses":{ + "201":{ + "body":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "ownerAssignment" + } + } + } +} diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Delete.json new file mode 100644 index 000000000000..f471ac446c3c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "ownerAssignment" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "ownerAssignment" + } + }, + "204":{} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Get.json new file mode 100644 index 000000000000..30b15fd71937 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/RoleAssignmentArtifact_Get.json @@ -0,0 +1,23 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "artifactName": "ownerAssignment" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/artifacts", + "name": "ownerAssignment" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedARMTemplateArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedARMTemplateArtifact_Get.json new file mode 100644 index 000000000000..17bee60a52bb --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedARMTemplateArtifact_Get.json @@ -0,0 +1,67 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "versionId":"V2", + "artifactName": "storageTemplate" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "storageTemplate" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedArtifact_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedArtifact_List.json new file mode 100644 index 000000000000..e3f053d5e4fb --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedArtifact_List.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "versionId": "V2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "ownerAssignment" + }, + { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "costCenterPolicy" + }, + { + "properties": { + "template": { + "contentVersion": "1.0.0.0", + "parameters": { + "storageAccountType": { + "type": "string", + "defaultValue": "Standard_LRS", + "allowedValues": [ + "Standard_LRS", + "Standard_GRS", + "Standard_ZRS", + "Premium_LRS" + ], + "metadata": { + "description": "Storage Account type" + } + } + }, + "variables": { + "storageAccountName": "[concat(uniquestring(resourceGroup().id), 'standardsa')]" + }, + "resources": [ + { + "type": "Microsoft.Storage/storageAccounts", + "name": "[variables('storageAccountName')]", + "apiVersion": "2016-01-01", + "location": "[resourceGroup().location]", + "sku": { + "name": "[parameters('storageAccountType')]" + }, + "kind": "Storage", + "properties": {} + } + ], + "outputs": { + "storageAccountName": { + "type": "string", + "value": "[variables('storageAccountName')]" + } + } + }, + "resourceGroup": "storageRG", + "parameters": { + "storageAccountType": { + "value": "[parameters('storageAccountType')]" + } + } + }, + "kind": "template", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/storageTemplate", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "storageTemplate" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Delete.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Delete.json new file mode 100644 index 000000000000..b584ffbf1366 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Delete.json @@ -0,0 +1,54 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "versionId": "v2" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "blueprintName":"simpleBlueprint", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type.", + "description": null + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription.", + "description": null + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment.", + "description": null + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints/versions", + "name": "v2" + } + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Get.json new file mode 100644 index 000000000000..d8a64f893572 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Get.json @@ -0,0 +1,53 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "versionId": "v2" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "blueprintName":"simpleBlueprint", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type.", + "description": null + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription.", + "description": null + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment.", + "description": null + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints/versions", + "name": "v2" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_List.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_List.json new file mode 100644 index 000000000000..b04c59eb4ce3 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_List.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName": "simpleBlueprint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "blueprintName": "simpleBlueprint", + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type." + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription." + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment." + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription", + "status": null + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/v1", + "type": "Microsoft.Blueprint/blueprints/versions", + "name": "v1" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Publish.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Publish.json new file mode 100644 index 000000000000..4471959bcc62 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedBlueprint_Publish.json @@ -0,0 +1,53 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "versionId": "v2" + }, + "responses":{ + "201":{ + "body":{ + "properties": { + "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}", + "blueprintName":"simpleBlueprint", + "parameters": { + "storageAccountType": { + "type": "string", + "metadata": { + "displayName": "storage account type.", + "description": null + } + }, + "costCenter": { + "type": "string", + "metadata": { + "displayName": "force cost center tag for all resources under given subscription.", + "description": null + } + }, + "owners": { + "type": "array", + "metadata": { + "displayName": "assign owners to subscription along with blueprint assignment.", + "description": null + } + } + }, + "resourceGroups": { + "storageRG": { + "metadata":{ + "displayName": "storage resource group", + "description": "Contains storageAccounts that collect all shoebox logs." + } + } + }, + "targetScope": "subscription" + }, + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "type": "Microsoft.Blueprint/blueprints/versions", + "name": "v2" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedPolicyAssignmentArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedPolicyAssignmentArtifact_Get.json new file mode 100644 index 000000000000..cad36be6b4d9 --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedPolicyAssignmentArtifact_Get.json @@ -0,0 +1,27 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "versionId":"V2", + "artifactName": "costCenterPolicy" + }, + "responses":{ + "200":{ + "body": { + "properties": { + "displayName": "force costCenter tag on all resources", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "parameters": { + "tagName": { "value": "costCenter" }, + "tagValue": { "value": "[parameter('costCenter')]" } + } + }, + "kind": "policyAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/costCenterPolicy", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "costCenterPolicy" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedRoleAssignmentArtifact_Get.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedRoleAssignmentArtifact_Get.json new file mode 100644 index 000000000000..73c0e6253c9c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPDef/SealedRoleAssignmentArtifact_Get.json @@ -0,0 +1,24 @@ +{ + "parameters":{ + "api-version":"2018-11-01-preview", + "scope":"subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b", + "blueprintName":"simpleBlueprint", + "versionId":"V2", + "artifactName": "ownerAssignment" + }, + "responses":{ + "200":{ + "body":{ + "properties": { + "displayName": "enforce owners of given subscription", + "roleDefinitionId": "/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7", + "principalIds": "[parameters('owners')]" + }, + "kind": "roleAssignment", + "id": "/subscriptions/f8df94f2-2f5a-4f4a-bcaf-1bb992fb564b/providers/Microsoft.Blueprint/blueprints/simpleBlueprint/versions/V2/artifacts/ownerAssignment", + "type": "Microsoft.Blueprint/blueprints/versions/artifacts", + "name": "ownerAssignment" + } + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/readme.go.md b/specification/blueprint/resource-manager/readme.go.md index 37f2194ec7d6..7bbbb41384ef 100644 --- a/specification/blueprint/resource-manager/readme.go.md +++ b/specification/blueprint/resource-manager/readme.go.md @@ -13,14 +13,23 @@ go: ``` yaml $(go) && $(multiapi) batch: - - tag: package-2017-11-preview + - tag: package-2018-11-preview ``` ### Tag: package-2017-11-preview and go -These settings apply only when `--tag=package-2015-11-preview --go` is specified on the command line. +These settings apply only when `--tag=package-2017-11-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-11-preview' && $(go) output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-11-11-preview/$(namespace) ``` + +### Tag: package-2018-11-preview and go + +These settings apply only when `--tag=package-2018-11-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-11-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-11-01-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/blueprint/resource-manager/readme.md b/specification/blueprint/resource-manager/readme.md index 1c86463570e2..003beb57cc0b 100644 --- a/specification/blueprint/resource-manager/readme.md +++ b/specification/blueprint/resource-manager/readme.md @@ -24,7 +24,7 @@ These are the global settings for the Blueprint API. title: BlueprintManagementClient description: Blueprint Client openapi-type: arm -tag: package-2017-11-preview +tag: package-2018-11-preview ``` @@ -38,6 +38,17 @@ input-file: - Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json ``` +### Tag: package-2018-11-preview + +These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11-preview' +input-file: +- Microsoft.Blueprint/preview/2018-11-01-preview/blueprintDefinition.json +- Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json +- Microsoft.Blueprint/preview/2018-11-01-preview/assignmentOperation.json +``` + --- # Code Generation @@ -50,6 +61,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-node + - repo: azure-sdk-for-python ``` @@ -137,4 +149,8 @@ directive: suppress: OperationsAPIImplementation where: $.paths reason: OperationsAPI for Microsoft.Management is out of scope. + - from: assignmentOperation.json + suppress: OperationsAPIImplementation + where: $.paths + reason: OperationsAPI for Microsoft.Management is out of scope. ``` diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json index 7be89405de6a..a457c748970e 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json @@ -494,6 +494,14 @@ }, "x-nullable": true }, + "brands": { + "description": "Array of brands detected in the image.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectedBrand" + }, + "x-nullable": true + }, "requestId": { "description": "Id of the REST API request.", "type": "string", @@ -715,6 +723,31 @@ }, "x-nullable": true }, + "DetectedBrand": { + "description": "A brand detected in an image.", + "type": "object", + "properties": { + "name": { + "description": "Label for the brand.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "Confidence score of having observed the brand in the image, as a value ranging from 0 to 1.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "rectangle": { + "$ref": "#/definitions/BoundingRect", + "description": "Approximate location of the detected brand.", + "readOnly": true + } + }, + "x-nullable": true + }, "ImageMetadata": { "description": "Image metadata.", "type": "object", @@ -1335,7 +1368,7 @@ "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. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English.", + "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. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English.", "required": false, "type": "array", "items": { @@ -1348,7 +1381,8 @@ "Color", "Tags", "Description", - "Objects" + "Objects", + "Brands" ], "x-nullable": false, "x-ms-enum": { @@ -1758,4 +1792,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithStream.json index 25563786840a..179147d658af 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithStream.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com", "Ocp-Apim-Subscription-Key": "{API key}", - "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType", "Objects"], + "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType", "Objects", "Brands"], "details": ["Celebrities", "Landmarks"], "language": "en", "Image": "{binary}" @@ -132,6 +132,28 @@ "confidence": 0.95 } } + ], + "brands": [ + { + "name": "Pepsi", + "confidence": 0.857, + "rectangle": { + "x": 489, + "y": 79, + "w": 161, + "h": 177 + } + }, + { + "name": "Coca-Cola", + "confidence": 0.893, + "rectangle": { + "x": 216, + "y": 55, + "w": 171, + "h": 372 + } + } ] } } diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithUrl.json index 8bd63c44fe61..8339de31d4b5 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithUrl.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com", "Ocp-Apim-Subscription-Key": "{API key}", - "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType", "Objects"], + "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType", "Objects", "Brands"], "details": ["Celebrities", "Landmarks"], "language": "en", "ImageUrl": "{url}" @@ -138,6 +138,28 @@ "confidence": 0.95 } } + ], + "brands": [ + { + "name": "Pepsi", + "confidence": 0.857, + "rectangle": { + "x": 489, + "y": 79, + "w": 161, + "h": 177 + } + }, + { + "name": "Coca-Cola", + "confidence": 0.893, + "rectangle": { + "x": 216, + "y": 55, + "w": 171, + "h": 372 + } + } ] } } diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json index f90629180b8b..383bb1ea9608 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json @@ -2128,6 +2128,278 @@ } } } + }, + "/snapshots": { + "post": { + "description": "Submit an operation to take a snapshot of face list, large face list, person group or large person group, with user-specified snapshot type, source object id, apply scope and an optional user data.
\nThe snapshot interfaces are for users to backup and restore their face data from one face subscription to another, inside same region or across regions. The workflow contains two phases, user first calls Snapshot - Take to create a copy of the source object and store it as a snapshot, then calls Snapshot - Apply to paste the snapshot to target subscription. The snapshots are stored in a centralized location (per Azure instance), so that they can be applied cross accounts and regions.
\nTaking snapshot is an asynchronous operation. An operation id can be obtained from the \"Operation-Location\" field in response header, to be used in OperationStatus - Get for tracking the progress of creating the snapshot. The snapshot id will be included in the \"resourceLocation\" field in OperationStatus - Get response when the operation status is \"succeeded\".
\nSnapshot taking time depends on the number of person and face entries in the source object. It could be in seconds, or up to several hours for 1,000,000 persons with multiple faces.
\nSnapshots will be automatically expired and cleaned in 48 hours after it is created by Snapshot - Take. User can delete the snapshot using Snapshot - Delete by themselves any time before expiration.
\nTaking snapshot for a certain object will not block any other operations against the object. All read-only operations (Get/List and Identify/FindSimilar/Verify) can be conducted as usual. For all writable operations, including Add/Update/Delete the source object or its persons/faces and Train, they are not blocked but not recommended because writable updates may not be reflected on the snapshot during its taking. After snapshot taking is completed, all readable and writable operations can work as normal. Snapshot will also include the training results of the source object, which means target subscription the snapshot applied to does not need re-train the target object before calling Identify/FindSimilar.
\n* Free-tier subscription quota: 100 take operations per month.\n* S0-tier subscription quota: 100 take operations per day.", + "operationId": "Snapshot_Take", + "parameters": [ + { + "name": "body", + "description": "Request body for taking a snapshot.", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/TakeSnapshotRequest" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "The snapshot taking task was queued successfully.", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of taking snapshot. The returned id is the operation id, rather than snapshot id. Snapshot id can be obtained only when the operation status becomes \"succeeded\" in OperationStatus - Get.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/APIError" + } + } + }, + "x-ms-examples": { + "Take a snapshot example": { + "$ref": "./examples/TakeSnapshot.json" + } + } + }, + "get": { + "description": "List all accessible snapshots with related information, including snapshots that were taken by the user, or snapshots to be applied to the user (subscription id was included in the applyScope in Snapshot - Take).", + "operationId": "Snapshot_List", + "parameters": [ + { + "name": "type", + "description": "User specified object type as a search filter.", + "in": "query", + "required": false, + "type": "string", + "x-ms-enum": { + "name": "SnapshotObjectType", + "modelAsString": false + }, + "enum": [ + "FaceList", + "LargeFaceList", + "LargePersonGroup", + "PersonGroup" + ] + }, + { + "$ref": "#/parameters/applyScope" + } + ], + "responses": { + "200": { + "description": "A successful call returns an array of snapshots with snapshot information.", + "schema": { + "$ref": "#/definitions/Snapshots" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/APIError" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "List snapshots example": { + "$ref": "./examples/ListSnapshots.json" + } + } + } + }, + "/snapshots/{snapshotId}": { + "get": { + "description": "Retrieve information about a snapshot. Snapshot is only accessible to the source subscription who took it, and target subscriptions included in the applyScope in Snapshot - Take.", + "operationId": "Snapshot_Get", + "parameters": [ + { + "$ref": "#/parameters/snapshotId" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A successful call returns the snapshot's information.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/APIError" + } + } + }, + "x-ms-examples": { + "Get snapshot example": { + "$ref": "./examples/GetSnapshot.json" + } + } + }, + "patch": { + "description": "Update the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot.", + "operationId": "Snapshot_Update", + "parameters": [ + { + "$ref": "#/parameters/snapshotId" + }, + { + "name": "body", + "description": "Request body for updating a snapshot.", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/UpdateSnapshotRequest" + } + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "A successful call returns an empty response body." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/APIError" + } + } + }, + "x-ms-examples": { + "Update snapshot example": { + "$ref": "./examples/UpdateSnapshot.json" + } + } + }, + "delete": { + "description": "Delete an existing snapshot according to the snapshotId. All object data and information in the snapshot will also be deleted. Only the source subscription who took the snapshot can delete the snapshot. If the user does not delete a snapshot with this API, the snapshot will still be automatically deleted in 48 hours after creation.", + "operationId": "Snapshot_Delete", + "parameters": [ + { + "$ref": "#/parameters/snapshotId" + } + ], + "responses": { + "200": { + "description": "A successful call returns an empty response body." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/APIError" + } + } + }, + "x-ms-examples": { + "Delete snapshot example": { + "$ref": "./examples/DeleteSnapshot.json" + } + } + } + }, + "/snapshots/{snapshotId}/apply": { + "post": { + "description": "Submit an operation to apply a snapshot to current subscription. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.
\nThe snapshot interfaces are for users to backup and restore their face data from one face subscription to another, inside same region or across regions. The workflow contains two phases, user first calls Snapshot - Take to create a copy of the source object and store it as a snapshot, then calls Snapshot - Apply to paste the snapshot to target subscription. The snapshots are stored in a centralized location (per Azure instance), so that they can be applied cross accounts and regions.
\nApplying snapshot is an asynchronous operation. An operation id can be obtained from the \"Operation-Location\" field in response header, to be used in OperationStatus - Get for tracking the progress of applying the snapshot. The target object id will be included in the \"resourceLocation\" field in OperationStatus - Get response when the operation status is \"succeeded\".
\nSnapshot applying time depends on the number of person and face entries in the snapshot object. It could be in seconds, or up to 1 hour for 1,000,000 persons with multiple faces.
\nSnapshots will be automatically expired and cleaned in 48 hours after it is created by Snapshot - Take. So the target subscription is required to apply the snapshot in 48 hours since its creation.
\nApplying a snapshot will not block any other operations against the target object, however it is not recommended because the correctness cannot be guaranteed during snapshot applying. After snapshot applying is completed, all operations towards the target object can work as normal. Snapshot also includes the training results of the source object, which means target subscription the snapshot applied to does not need re-train the target object before calling Identify/FindSimilar.
\nOne snapshot can be applied multiple times in parallel, while currently only CreateNew apply mode is supported, which means the apply operation will fail if target subscription already contains an object of same type and using the same objectId. Users can specify the \"objectId\" in request body to avoid such conflicts.
\n* Free-tier subscription quota: 100 apply operations per month.\n* S0-tier subscription quota: 100 apply operations per day.", + "operationId": "Snapshot_Apply", + "parameters": [ + { + "$ref": "#/parameters/snapshotId" + }, + { + "name": "body", + "description": "Request body for applying a snapshot.", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/ApplySnapshotRequest" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "The snapshot applying task was queued successfully.", + "headers": { + "Operation-Location": { + "description": "Operation location with an operation id used to track the progress of applying the snapshot by OperationStatus - Get.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/APIError" + } + } + }, + "x-ms-examples": { + "Apply snapshot example": { + "$ref": "./examples/ApplySnapshot.json" + } + } + } + }, + "/operations/{operationId}": { + "get": { + "description": "Retrieve the status of a take/apply snapshot operation.", + "operationId": "Snapshot_GetOperationStatus", + "parameters": [ + { + "$ref": "#/parameters/operationId" + } + ], + "responses": { + "200": { + "description": "A successful call returns the snapshot operation's status.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/APIError" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get snapshot operation status example": { + "$ref": "./examples/GetSnapshotOperationStatus.json" + } + } + } } }, "x-ms-paths": { @@ -2970,7 +3242,7 @@ }, "faceListId": { "type": "string", - "description": "An existing user-specified unique candidate face list, created in Face List - Create a Face List. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time。", + "description": "An existing user-specified unique candidate face list, created in Face List - Create a Face List. Face list contains a set of persistedFaceIds which are persisted and will never expire. Parameter faceListId, largeFaceListId and faceIds should not be provided at the same time.", "maxLength": 64, "pattern": "^[a-z0-9-_]+$" }, @@ -3506,6 +3778,203 @@ "maxLength": 16384 } } + }, + "ApplyScope": { + "type": "array", + "description": "Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + } + }, + "ApplySnapshotRequest": { + "type": "object", + "required": [ + "objectId" + ], + "description": "Request body for applying snapshot operation.", + "properties": { + "objectId": { + "type": "string", + "description": "User specified target object id to be created from the snapshot.", + "maxLength": 64, + "pattern": "^[a-z0-9-_]+$" + }, + "mode": { + "type": "string", + "description": "Snapshot applying mode. Currently only CreateNew is supported, which means the apply operation will fail if target subscription already contains an object of same type and using the same objectId. Users can specify the \"objectId\" in request body to avoid such conflicts.", + "default": "CreateNew", + "x-nullable": false, + "x-ms-enum": { + "name": "SnapshotApplyMode", + "modelAsString": false + }, + "enum": [ + "CreateNew" + ] + } + } + }, + "Snapshots": { + "type": "array", + "description": "An array of snapshots.", + "items": { + "$ref": "#/definitions/Snapshot" + } + }, + "Snapshot": { + "type": "object", + "required": [ + "id", + "account", + "type", + "applyScope", + "createdTime", + "lastUpdateTime" + ], + "description": "Snapshot object.", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "Snapshot id." + }, + "account": { + "type": "string", + "description": "Azure Cognitive Service Face account id of the subscriber who created the snapshot by Snapshot - Take." + }, + "type": { + "type": "string", + "description": "Type of the source object in the snapshot, specified by the subscriber who created the snapshot when calling Snapshot - Take. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported.", + "x-ms-enum": { + "name": "SnapshotObjectType", + "modelAsString": false + }, + "enum": [ + "FaceList", + "LargeFaceList", + "LargePersonGroup", + "PersonGroup" + ] + }, + "applyScope": { + "description": "Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.", + "$ref": "#/definitions/ApplyScope" + }, + "userData": { + "type": "string", + "description": "User specified data about the snapshot for any purpose. Length should not exceed 16KB.", + "maxLength": 16384 + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "A combined UTC date and time string that describes the created time of the snapshot. E.g. 2018-12-25T11:41:02.2331413Z." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "A combined UTC date and time string that describes the last time when the snapshot was created or updated by Snapshot - Update. E.g. 2018-12-25T11:51:27.8705696Z." + } + } + }, + "TakeSnapshotRequest": { + "type": "object", + "required": [ + "type", + "objectId", + "applyScope" + ], + "description": "Request body for taking snapshot operation.", + "properties": { + "type": { + "type": "string", + "description": "User specified type for the source object to take snapshot from. Currently FaceList, PersonGroup, LargeFaceList and LargePersonGroup are supported.", + "x-ms-enum": { + "name": "SnapshotObjectType", + "modelAsString": false + }, + "enum": [ + "FaceList", + "LargeFaceList", + "LargePersonGroup", + "PersonGroup" + ] + }, + "objectId": { + "type": "string", + "description": "User specified source object id to take snapshot from.", + "maxLength": 64, + "pattern": "^[a-z0-9-_]+$" + }, + "applyScope": { + "description": "User specified array of target Face subscription ids for the snapshot. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.", + "$ref": "#/definitions/ApplyScope" + }, + "userData": { + "type": "string", + "description": "User specified data about the snapshot for any purpose. Length should not exceed 16KB.", + "maxLength": 16384 + } + } + }, + "UpdateSnapshotRequest": { + "type": "object", + "description": "Request body for updating a snapshot, with a combination of user defined apply scope and user specified data.", + "properties": { + "applyScope": { + "description": "Array of the target Face subscription ids for the snapshot, specified by the user who created the snapshot when calling Snapshot - Take. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply it.", + "$ref": "#/definitions/ApplyScope" + }, + "userData": { + "type": "string", + "description": "User specified data about the snapshot for any purpose. Length should not exceed 16KB.", + "maxLength": 16384 + } + } + }, + "OperationStatus": { + "type": "object", + "required": [ + "status", + "createdTime" + ], + "description": "Operation status object. Operation refers to the asynchronous backend task including taking a snapshot and applying a snapshot.", + "properties": { + "status": { + "type": "string", + "description": "Operation status: notstarted, running, succeeded, failed. If the operation is requested and waiting to perform, the status is notstarted. If the operation is ongoing in backend, the status is running. Status succeeded means the operation is completed successfully, specifically for snapshot taking operation, it illustrates the snapshot is well taken and ready to apply, and for snapshot applying operation, it presents the target object has finished creating by the snapshot and ready to be used. Status failed is often caused by editing the source object while taking the snapshot or editing the target object while applying the snapshot before completion, see the field \"message\" to check the failure reason.", + "x-ms-enum": { + "name": "OperationStatusType", + "modelAsString": false + }, + "enum": [ + "notstarted", + "running", + "succeeded", + "failed" + ] + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "A combined UTC date and time string that describes the time when the operation (take or apply a snapshot) is requested. E.g. 2018-12-25T11:41:02.2331413Z." + }, + "lastActionTime": { + "type": "string", + "format": "date-time", + "description": "A combined UTC date and time string that describes the last time the operation (take or apply a snapshot) is actively migrating data. The lastActionTime will keep increasing until the operation finishes. E.g. 2018-12-25T11:51:27.8705696Z." + }, + "resourceLocation": { + "type": "string", + "description": "When the operation succeeds successfully, for snapshot taking operation the snapshot id will be included in this field, and for snapshot applying operation, the path to get the target object will be returned in this field." + }, + "message": { + "type": "string", + "description": "Show failure message when operation fails (omitted when operation succeeds)." + } + } } }, "parameters": { @@ -3632,6 +4101,40 @@ "x-ms-parameter-location": "method", "collectionFormat": "csv" }, + "applyScope": { + "name": "applyScope", + "description": "User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot, specified by the user who created the snapshot by Snapshot - Take.", + "in": "query", + "required": false, + "type": "array", + "x-ms-parameter-location": "method", + "collectionFormat": "csv", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + } + }, + "operationId": { + "name": "operationId", + "in": "path", + "description": "Id referencing a particular take/apply snapshot operation.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "collectionFormat": "csv" + }, + "snapshotId": { + "name": "snapshotId", + "in": "path", + "description": "Id referencing a particular snapshot.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method", + "collectionFormat": "csv" + }, "Endpoint": { "name": "Endpoint", "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/ApplySnapshot.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/ApplySnapshot.json new file mode 100644 index 000000000000..66e530f04bfa --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/ApplySnapshot.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "snapshotId": "e58b3f08-1e8b-4165-81df-aa9858f233dc", + "body": { + "objectId": "target-face-list-id", + "mode": "CreateNew" + } + }, + "responses": { + "202": { + "body": "", + "header": { + "Operation-Location": "/operations/84276574-2a2a-4540-a1b0-f65d834d225b" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteSnapshot.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteSnapshot.json new file mode 100644 index 000000000000..01f8f2da709f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/DeleteSnapshot.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "snapshotId": "e58b3f08-1e8b-4165-81df-aa9858f233dc" + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetSnapshot.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetSnapshot.json new file mode 100644 index 000000000000..82e187ceea3a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetSnapshot.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "snapshotId": "e58b3f08-1e8b-4165-81df-aa9858f233dc" + }, + "responses": { + "200": { + "body": { + "id": "e58b3f08-1e8b-4165-81df-aa9858f233dc", + "account": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01", + "type": "FaceList", + "applyScope": [ + "35230F59-AA9C-45E0-AB5E-C859BF1A5429", + "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB" + ], + "userData": "User-provided data attached to the snapshot.", + "createdTime": "2018-12-25T11:41:02.2331413Z", + "lastUpdateTime": "2018-12-25T11:51:27.8705696Z" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetSnapshotOperationStatus.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetSnapshotOperationStatus.json new file mode 100644 index 000000000000..43ad82a03af2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/GetSnapshotOperationStatus.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "operationId": "a63a3bdd-a1db-4d05-87b8-dbad6850062a" + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "createdTime": "2018-12-25T11:41:02.2331413Z", + "lastActionTime": "2018-12-25T11:51:27.8705696Z", + "resourceLocation": "/snapshots/e58b3f08-1e8b-4165-81df-aa9858f233dc", + "message": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/ListSnapshots.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/ListSnapshots.json new file mode 100644 index 000000000000..80df82bea131 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/ListSnapshots.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "type": "FaceList", + "applyScope": [ + "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB" + ] + }, + "responses": { + "200": { + "body": [ + { + "id": "e58b3f08-1e8b-4165-81df-aa9858f233dc", + "account": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01", + "type": "FaceList", + "applyScope": [ + "35230F59-AA9C-45E0-AB5E-C859BF1A5429", + "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB" + ], + "userData": "User-provided data attached to the snapshot1.", + "createdTime": "2018-12-25T11:41:02.2331413Z", + "lastUpdateTime": "2018-12-25T11:51:27.8705696Z" + }, + { + "id": "a61e61e4-c3d1-4d33-8ae8-676e6104757d", + "account": "/subscriptions/6622996e-0149-4b22-9703-4216dc948d52/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01", + "type": "FaceList", + "applyScope": [ + "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB" + ], + "userData": "User-provided data attached to the snapshot2.", + "createdTime": "2018-12-29T17:09:32.3298483Z", + "lastUpdateTime": "2018-12-29T17:14:34.5645877Z" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/TakeSnapshot.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/TakeSnapshot.json new file mode 100644 index 000000000000..d00242c7deda --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/TakeSnapshot.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "body": { + "type": "FaceList", + "objectId": "source-face-list-id", + "applyScope": [ + "35230F59-AA9C-45E0-AB5E-C859BF1A5429", + "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB" + ], + "userData": "User-provided data attached to the snapshot." + } + }, + "responses": { + "202": { + "body": "", + "header": { + "Operation-Location": "/operations/a63a3bdd-a1db-4d05-87b8-dbad6850062a" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdateSnapshot.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdateSnapshot.json new file mode 100644 index 000000000000..4c9e69a30e76 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/examples/UpdateSnapshot.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "snapshotId": "e58b3f08-1e8b-4165-81df-aa9858f233dc", + "body": { + "applyScope": [ + "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB" + ], + "userData": "User-provided data attached to the snapshot." + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file 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 63aef12d1da8..36bbf757be65 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 @@ -238,6 +238,9 @@ }, "sentimentAnalysis": { "$ref": "#/definitions/Sentiment" + }, + "connectedServiceResult": { + "$ref": "#/definitions/LuisResult" } } }, 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 8f91f7a44b9e..22fe04767512 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 @@ -855,6 +855,10 @@ "internalId": { "type": "string", "description": "The internal identifier." + }, + "customSubDomainName": { + "type": "string", + "description": "Optional subdomain name used for token-based authentication." } }, "description": "Properties of Cognitive Services account." 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 ecf037f0279d..31600d55e6d4 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 @@ -3237,7 +3237,7 @@ "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](virtualmachines-list-sizes-availability-set.md)

[List all available virtual machine sizes in a region](virtualmachines-list-sizes-region.md)

[List all available virtual machine sizes for resizing](virtualmachines-list-sizes-for-resizing.md)", + "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", @@ -3672,7 +3672,7 @@ }, "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": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -3697,7 +3697,7 @@ "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)." + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "adminUsername": { "type": "string", 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 3bf31e40bb76..51c7a6ade91b 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 @@ -3326,7 +3326,7 @@ "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](virtualmachines-list-sizes-availability-set.md)

[List all available virtual machine sizes in a region](virtualmachines-list-sizes-region.md)

[List all available virtual machine sizes for resizing](virtualmachines-list-sizes-for-resizing.md)", + "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", @@ -3769,7 +3769,7 @@ }, "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": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -3794,7 +3794,7 @@ "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)." + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "adminUsername": { "type": "string", 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 8a8e5e5e9ab4..7b39f2a0a06b 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 @@ -4346,7 +4346,7 @@ "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](virtualmachines-list-sizes-availability-set.md)

[List all available virtual machine sizes in a region](virtualmachines-list-sizes-region.md)

[List all available virtual machine sizes for resizing](virtualmachines-list-sizes-for-resizing.md)", + "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", @@ -4858,7 +4858,7 @@ }, "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": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -4883,7 +4883,7 @@ "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)." + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "adminUsername": { "type": "string", 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 a2db64ba6b8d..28bd9ec41472 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 @@ -5630,7 +5630,7 @@ }, "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": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -5655,7 +5655,7 @@ "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)." + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "adminUsername": { "type": "string", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json index 40ae01b53db6..8f2a19dbf908 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json @@ -5459,7 +5459,7 @@ }, "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": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -5484,7 +5484,7 @@ "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)." + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "adminUsername": { "type": "string", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index e43aead20e3a..10248e6a673f 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -5632,7 +5632,7 @@ }, "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": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -5657,7 +5657,7 @@ "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)." + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "adminUsername": { "type": "string", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/disk.json index 05cee4453694..d63679f08d75 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/disk.json @@ -879,12 +879,12 @@ "diskIOPSReadWrite": { "type":"integer", "format": "int64", - "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes. For a description of the range of values you can set, see [Ultra SSD Managed Disk Offerings](https://docs.microsoft.com/azure/virtual-machines/windows/disks-ultra-ssd#ultra-ssd-managed-disk-offerings)." }, "diskMBpsReadWrite": { "type":"integer", "format": "int32", - "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10. For a description of the range of values you can set, see [Ultra SSD Managed Disk Offerings](https://docs.microsoft.com/azure/virtual-machines/windows/disks-ultra-ssd#ultra-ssd-managed-disk-offerings)." } }, "required": [ diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index 12aeabee2a5a..392a3784879c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -5647,7 +5647,7 @@ }, "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": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -5672,7 +5672,7 @@ "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)." + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

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

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

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." }, "adminUsername": { "type": "string", @@ -7801,6 +7801,10 @@ "type": "boolean", "description": "Specifies whether the latest model has been applied to the virtual machine." }, + "protectFromScaleIn" : { + "type": "boolean", + "description": "Specifies whether the virtual machine instance shouldn't be considered for deletion during a scale-in operation" + }, "vmId": { "readOnly": true, "type": "string", diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 5616fae4f3ff..b8208e568ac3 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -177,6 +177,14 @@ directive: suppress: - DefinitionsPropertiesNamesCamelCase + - where: + - $.definitions.ContainerService + suppress: + - TrackedResourcePatchOperation + reason: + - ACS service is deprecated so a PATCH endpoint won't be implemented + + ``` ### Tag: package-2018-10-01 diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/consumption.json new file mode 100644 index 000000000000..750e025bbe37 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/consumption.json @@ -0,0 +1,2930 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "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": { + "/{scope}/providers/Microsoft.Consumption/usageDetails": { + "get": { + "tags": [ + "UsageDetails" + ], + "operationId": "UsageDetails_List", + "description": "Lists the usage details for the defined scope. 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" + }, + "UsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriod.json" + }, + "UsageDetailsExpand": { + "$ref": "./examples/UsageDetailsExpand.json" + }, + "UsageDetailsListForBillingPeriodGroupByTag": { + "$ref": "./examples/UsageDetailsListForBillingPeriodGroupByTag.json" + }, + "BillingAccountUsageDetailsList": { + "$ref": "./examples/UsageDetailsListByBillingAccount.json" + }, + "BillingAccountUsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByBillingAccount.json" + }, + "DepartmentUsageDetailsList": { + "$ref": "./examples/UsageDetailsListByDepartment.json" + }, + "DepartmentUsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByDepartment.json" + }, + "EnrollmentAccountUsageDetailsList": { + "$ref": "./examples/UsageDetailsListByEnrollmentAccount.json" + }, + "EnrollmentAccountUsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json" + }, + "ManagementGroupUsageDetailsList": { + "$ref": "./examples/UsageDetailsListByManagementGroup.json" + }, + "ManagementGroupUsageDetailsListForBillingPeriod": { + "$ref": "./examples/UsageDetailsListForBillingPeriodByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "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" + } + } + }, + "/{scope}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_List", + "description": "Lists the marketplaces for a scope at the defined scope. 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": { + "SubscriptionMarketplacesList": { + "$ref": "./examples/MarketplacesList.json" + }, + "SubscriptionMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesListForBillingPeriod.json" + }, + "BillingAccountMarketplacesList": { + "$ref": "./examples/MarketplacesByBillingAccountList.json" + }, + "BillingAccountMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByBillingAccountListForBillingPeriod.json" + }, + "DepartmentMarketplacesList": { + "$ref": "./examples/MarketplacesByDepartmentList.json" + }, + "DepartmentMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByDepartment_ListByBillingPeriod.json" + }, + "EnrollmentAccountMarketplacesList": { + "$ref": "./examples/MarketplacesByEnrollmentAccountList.json" + }, + "EnrollmentAccountMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json" + }, + "ManagementGroupMarketplacesList": { + "$ref": "./examples/MarketplacesByManagementGroupList.json" + }, + "ManagementGroupMarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByManagementGroup_ListForBillingPeriod.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/scopeMarketplaceParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "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" + } + } + }, + "/{scope}/providers/Microsoft.Consumption/budgets": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_List", + "description": "Lists all budgets for the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "BudgetsList": { + "$ref": "./examples/BudgetsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "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" + } + } + }, + "/{scope}/providers/Microsoft.Consumption/budgets/{budgetName}": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Get", + "description": "Gets the budget for the scope by budget name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Budget": { + "$ref": "./examples/Budget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/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/scopeBudgetParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Budget" + }, + "description": "Parameters supplied to the Create Budget operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "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/scopeBudgetParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Consumption/tags": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tags_Get", + "description": "Get all available tag keys for the defined scope", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "Tags_Get": { + "$ref": "./examples/Tags.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeTagsParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "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" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Consumption/charges": { + "get": { + "tags": [ + "Charges" + ], + "operationId": "Charges_ListByScope", + "description": "Lists the charges based for the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ChargesListForEnrollmentAccount": { + "$ref": "./examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json" + }, + "ChangesForBillingPeriodByEnrollmentAccount": { + "$ref": "./examples/ChargesForBillingPeriodByEnrollmentAccount.json" + }, + "ChargesListByDepartment": { + "$ref": "./examples/ChargesListForDepartmentFilterByStartEndDate.json" + }, + "ChangesForBillingPeriodByDepartment": { + "$ref": "./examples/ChargesForBillingPeriodByDepartment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeChargesParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). 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" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ChargeSummary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/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 recommendations 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/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/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" + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/aggregatedcost": { + "get": { + "tags": [ + "AggregatedCost" + ], + "operationId": "AggregatedCost_GetByManagementGroup", + "description": "Provides the aggregate cost of a management group and all child management groups by current billing period.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "AggregatedCostByManagementGroup": { + "$ref": "./examples/AggregatedCostByManagementGroup.json" + }, + "AggregatedCostByManagementGroupFilterByDate": { + "$ref": "./examples/AggregatedCostByManagementGroupFilterByDate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter aggregated cost by properties/usageStart (Utc time), properties/usageEnd (Utc time). 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" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ManagementGroupAggregatedCostResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/Microsoft.Consumption/aggregatedcost": { + "get": { + "tags": [ + "AggregatedCost" + ], + "operationId": "AggregatedCost_GetForBillingPeriodByManagementGroup", + "description": "Provides the aggregate cost of a management group and all child management groups by specified billing period", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "AggregatedCostListForBillingPeriodByManagementGroup": { + "$ref": "./examples/AggregatedCostForBillingPeriodByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ManagementGroupAggregatedCostResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "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 + }, + "isRecurringCharge": { + "description": "Flag indicating whether this is a recurring charge or not.", + "type": "boolean", + "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 additional info 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 additional info 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": "Recommended 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 period. 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" + ] + }, + "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 + } + } + }, + "ManagementGroupAggregatedCostResult": { + "description": "A management group aggregated cost resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagementGroupAggregatedCostProperties", + "title": "Management Group Aggregated Cost properties" + } + } + }, + "ManagementGroupAggregatedCostProperties": { + "description": "The properties of the Management Group Aggregated Cost.", + "type": "object", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the aggregated cost belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "The start of the date time range covered by aggregated cost.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "usageEnd": { + "description": "The end of the date time range covered by the aggregated cost.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "azureCharges": { + "description": "Azure Charges.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "marketplaceCharges": { + "description": "Marketplace Charges.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges Billed Separately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the meter is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "children": { + "description": "Children of a management group", + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupAggregatedCostResult" + } + }, + "includedSubscriptions": { + "description": "List of subscription Guids included in the calculation of aggregated cost", + "type": "array", + "items": { + "type": "string" + } + }, + "excludedSubscriptions": { + "description": "List of subscription Guids excluded from the calculation of aggregated cost", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ChargesListResult": { + "description": "Result of listing charge summary.", + "properties": { + "value": { + "description": "The list of charge summary", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ChargeSummary" + } + } + } + }, + "ChargeSummary": { + "description": "A charge summary resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ChargeSummaryProperties", + "title": "Charge summary properties" + } + } + }, + "ChargeSummaryProperties": { + "description": "The properties of the charge summary.", + "type": "object", + "properties": { + "billingPeriodId": { + "description": "The id of the billing period resource that the charge belongs to.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "Usage start date.", + "type": "string", + "readOnly": true + }, + "usageEnd": { + "description": " Usage end date.", + "type": "string", + "readOnly": true + }, + "azureCharges": { + "description": "Azure Charges.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "chargesBilledSeparately": { + "description": "Charges Billed separately.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "marketplaceCharges": { + "description": "Marketplace Charges.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "currency": { + "description": "Currency Code", + "type": "string", + "readOnly": true + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "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 scenario, this field will be used to determine whether the user is updating the latest version or not." + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "scopeChargesParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with usage details operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope. For department and enrollment accounts, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeUsageDetailsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeMarketplaceParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with marketplace operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and ManagementGroup, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeBudgetParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with budget operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope..", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeTagsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with tags operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope..", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "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 2019-01-01." + }, + "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" + } + ] + } + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "description": "Azure Management Group 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/2019-01-01/examples/AggregatedCostByManagementGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/AggregatedCostByManagementGroup.json new file mode 100644 index 000000000000..7fcef131267e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/AggregatedCostByManagementGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "managementGroupForTest" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1", + "name": "aggregatedcostId1", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "includedSubscriptions": [ + "1caaa5a3-2b66-438e-8ab4-bce37d518c5d" + ], + "excludedSubscriptions": [], + "usageStart": "2019-01-01T00:00:00.0000000Z", + "usageEnd": "2018-10-31T00:00:00.0000000Z", + "azureCharges": 250.9876, + "marketplaceCharges": 150.786, + "chargesBilledSeparately": 120.345, + "currency": "USD", + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2", + "name": "aggregatedcostId2", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "includedSubscriptions": [ + "c349567d-c83a-48c9-ab0e-578c69dc97a4" + ], + "excludedSubscriptions": [], + "usageStart": "2019-01-01T00:00:00.0000000Z", + "usageEnd": "2018-10-31T00:00:00.0000000Z", + "azureCharges": 150.0, + "marketplaceCharges": 50.786, + "chargesBilledSeparately": 30.345, + "currency": "USD", + "children": [] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/AggregatedCostByManagementGroupFilterByDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/AggregatedCostByManagementGroupFilterByDate.json new file mode 100644 index 000000000000..c290544acea8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/AggregatedCostByManagementGroupFilterByDate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "managementGroupForTest", + "$filter": "usageStart ge '2018-08-15' and properties/usageStart le '2018-08-31'" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1", + "name": "aggregatedcostId1", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "includedSubscriptions": [ + "1caaa5a3-2b66-438e-8ab4-bce37d518c5d" + ], + "excludedSubscriptions": [], + "usageStart": "2018-08-15T00:00:00.0000000Z", + "usageEnd": "2018-08-31T00:00:00.0000000Z", + "azureCharges": 150.9876, + "marketplaceCharges": 80.786, + "chargesBilledSeparately": 90.345, + "currency": "USD", + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2", + "name": "aggregatedcostId2", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "includedSubscriptions": [ + "c349567d-c83a-48c9-ab0e-578c69dc97a4" + ], + "excludedSubscriptions": [], + "usageStart": "2018-08-15T00:00:00.0000000Z", + "usageEnd": "2018-08-31T00:00:00.0000000Z", + "azureCharges": 50.0, + "marketplaceCharges": 10.786, + "chargesBilledSeparately": 30.345, + "currency": "USD", + "children": [] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/AggregatedCostForBillingPeriodByManagementGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/AggregatedCostForBillingPeriodByManagementGroup.json new file mode 100644 index 000000000000..b9848333b82f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/AggregatedCostForBillingPeriodByManagementGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "managementGroupForTest", + "billingPeriodName": "201807" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupForTest/providers/Microsoft.Consumption/aggregatedcostId1", + "name": "aggregatedcostId1", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "usageStart": "2018-07-01T00:00:00.0000000Z", + "usageEnd": "2018-07-31T00:00:00.0000000Z", + "azureCharges": 250.9876, + "marketplaceCharges": 150.786, + "chargesBilledSeparately": 120.345, + "currency": "USD", + "children": [ + { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupChildForTest/providers/Microsoft.Consumption/aggregatedcostId2", + "name": "aggregatedcostId2", + "type": "Microsoft.Consumption/aggregatedcost", + "properties": { + "usageStart": "2018-07-01T00:00:00.0000000Z", + "usageEnd": "2018-07-31T00:00:00.0000000Z", + "azureCharges": 150.0, + "marketplaceCharges": 50.786, + "chargesBilledSeparately": 30.345, + "currency": "USD", + "children": [] + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/BalancesByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/BalancesByBillingAccount.json new file mode 100644 index 000000000000..a73b7922c831 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/BalancesByBillingAccount.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "123456" + }, + "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/2019-01-01/examples/BalancesByBillingAccountForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/BalancesByBillingAccountForBillingPeriod.json new file mode 100644 index 000000000000..ed337d0604ea --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/BalancesByBillingAccountForBillingPeriod.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/Budget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/Budget.json new file mode 100644 index 000000000000..0fe3cc892bf6 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/Budget.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/BudgetsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/BudgetsList.json new file mode 100644 index 000000000000..68168745438c --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/BudgetsList.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ChargesForBillingPeriodByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesForBillingPeriodByDepartment.json new file mode 100644 index 000000000000..a8ed86744b00 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesForBillingPeriodByDepartment.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "1234", + "departmentId": "42425", + "billingPeriodName": "201804" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/departments/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesForBillingPeriodByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesForBillingPeriodByEnrollmentAccount.json new file mode 100644 index 000000000000..eed1b8fcd1df --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesForBillingPeriodByEnrollmentAccount.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "1234", + "enrollmentAccountId": "42425", + "billingPeriodName": "201804" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForDepartment.json new file mode 100644 index 000000000000..419db8105b0e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForDepartment.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "1234", + "departmentId": "42425", + "$filter": "usageStart eq '2018-04-01' AND usageEnd eq '2018-05-30'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/departments/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/departments/42425/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201805", + "usageStart": "2018-05-01", + "usageEnd": "2018-05-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForDepartmentFilterByStartEndDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForDepartmentFilterByStartEndDate.json new file mode 100644 index 000000000000..419db8105b0e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForDepartmentFilterByStartEndDate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "1234", + "departmentId": "42425", + "$filter": "usageStart eq '2018-04-01' AND usageEnd eq '2018-05-30'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/departments/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/departments/42425/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201805", + "usageStart": "2018-05-01", + "usageEnd": "2018-05-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForEnrollmentAccount.json new file mode 100644 index 000000000000..9e114eba0f52 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForEnrollmentAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "1234", + "enrollmentAccountId": "42425", + "$filter": "usageStart eq '2018-04-01' AND usageEnd eq '2018-05-30'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201805", + "usageStart": "2018-05-01", + "usageEnd": "2018-05-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json new file mode 100644 index 000000000000..5ccd2184b596 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ChargesListForEnrollmentAccountFilterByStartEndDate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "1234", + "enrollmentAccountId": "42425" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425/providers/Microsoft.Consumption/charges/chargeSummaryId1", + "name": "chargeSummaryId1", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201804", + "usageStart": "2018-04-01", + "usageEnd": "2018-04-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/1234/enrollmentAccounts/42425/providers/Microsoft.Consumption/charges/chargeSummaryId2", + "name": "chargeSummaryId2", + "type": "Microsoft.Consumption/charges", + "properties": { + "billingPeriodId": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201805", + "usageStart": "2018-05-01", + "usageEnd": "2018-05-30", + "azureCharges": 5000.00, + "chargesBilledSeparately": 60.90, + "marketplaceCharges": 100.00, + "currency": "USD" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/CreateOrUpdateBudget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/CreateOrUpdateBudget.json new file mode 100644 index 000000000000..6fda82a09118 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/CreateOrUpdateBudget.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/DeleteBudget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/DeleteBudget.json new file mode 100644 index 000000000000..d9ce5c87e58f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/DeleteBudget.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ForecastsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ForecastsList.json new file mode 100644 index 000000000000..4580f56dd6d6 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ForecastsList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ForecastsListFilterByDates.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ForecastsListFilterByDates.json new file mode 100644 index 000000000000..2a44e1977fda --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ForecastsListFilterByDates.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ForecastsListFilterByGrain.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ForecastsListFilterByGrain.json new file mode 100644 index 000000000000..148e4bf8345e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ForecastsListFilterByGrain.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/MarketplacesByBillingAccountList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByBillingAccountList.json new file mode 100644 index 000000000000..df63ac8207d1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByBillingAccountList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplaceId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByBillingAccountListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByBillingAccountListForBillingPeriod.json new file mode 100644 index 000000000000..141dab5af041 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByBillingAccountListForBillingPeriod.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByDepartmentList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByDepartmentList.json new file mode 100644 index 000000000000..5388520f0af8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByDepartmentList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByDepartment_ListByBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByDepartment_ListByBillingPeriod.json new file mode 100644 index 000000000000..5388520f0af8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByDepartment_ListByBillingPeriod.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByEnrollmentAccountList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByEnrollmentAccountList.json new file mode 100644 index 000000000000..f19e01eaeabf --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByEnrollmentAccountList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json new file mode 100644 index 000000000000..f19e01eaeabf --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByEnrollmentAccounts_ListByBillingPeriod.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByManagementGroupList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByManagementGroupList.json new file mode 100644 index 000000000000..48fea95f1c65 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByManagementGroupList.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "managementGroupForTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201810/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-10-13T00:00:00Z", + "usageEnd": "2018-10-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810/providers/Microsoft.Consumption/marketplaces/marketplaceId2", + "name": "marketplacesId2", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account2", + "additionalProperties": "additionalProperties", + "costCenter": "Center2", + "departmentName": "Department2", + "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-10-13T00:00:00Z", + "usageEnd": "2018-10-13T23:59:59Z", + "instanceName": "shared2", + "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared2", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "11111111-1111-1111-1111-111111111111", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "11111111-1111-1111-1111-111111111111", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "11111111-1111-1111-1111-111111111111", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json new file mode 100644 index 000000000000..5b2c54a4c4f5 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "managementGroupForTest", + "billingPeriodName": "201808" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201808/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201808", + "usageStart": "2018-08-13T00:00:00Z", + "usageEnd": "2018-08-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201808/providers/Microsoft.Consumption/marketplaces/marketplaceId2", + "name": "marketplacesId2", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account2", + "additionalProperties": "additionalProperties", + "costCenter": "Center2", + "departmentName": "Department2", + "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-08-13T00:00:00Z", + "usageEnd": "2018-08-13T23:59:59Z", + "instanceName": "shared2", + "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared2", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "11111111-1111-1111-1111-111111111111", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "11111111-1111-1111-1111-111111111111", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "11111111-1111-1111-1111-111111111111", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesList.json new file mode 100644 index 000000000000..95a8ec0f3415 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201702/providers/Microsoft.Consumption/marketPlaces/marketplaceId1", + "name": "marketplaceId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesListForBillingPeriod.json new file mode 100644 index 000000000000..44ef8a2642e1 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/MarketplacesListForBillingPeriod.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "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", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/PriceSheet.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/PriceSheet.json new file mode 100644 index 000000000000..25264de19e17 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/PriceSheet.json @@ -0,0 +1,34 @@ +{ + "parameters": + { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "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", + "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/2019-01-01/examples/PriceSheetExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/PriceSheetExpand.json new file mode 100644 index 000000000000..04489f630772 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/PriceSheetExpand.json @@ -0,0 +1,45 @@ +{ + "parameters": + { + "api-version": "2019-01-01", + "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/2019-01-01/examples/PriceSheetForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/PriceSheetForBillingPeriod.json new file mode 100644 index 000000000000..f158fc514b24 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/PriceSheetForBillingPeriod.json @@ -0,0 +1,35 @@ +{ + "parameters": + { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ReservationDetails.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationDetails.json new file mode 100644 index 000000000000..d994a1f95e0f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationDetails.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ReservationDetailsWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationDetailsWithReservationId.json new file mode 100644 index 000000000000..60032b581d06 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationDetailsWithReservationId.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json new file mode 100644 index 000000000000..51ac589592b8 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ReservationRecommendationsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationRecommendationsList.json new file mode 100644 index 000000000000..47baf5e017c9 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationRecommendationsList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ReservationSummariesDaily.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationSummariesDaily.json new file mode 100644 index 000000000000..76da0fe31073 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationSummariesDaily.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ReservationSummariesDailyWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationSummariesDailyWithReservationId.json new file mode 100644 index 000000000000..45bf520c257a --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationSummariesDailyWithReservationId.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ReservationSummariesMonthly.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationSummariesMonthly.json new file mode 100644 index 000000000000..6d1365c7587d --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationSummariesMonthly.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/ReservationSummariesMonthlyWithReservationId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationSummariesMonthlyWithReservationId.json new file mode 100644 index 000000000000..02398ead0d54 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/ReservationSummariesMonthlyWithReservationId.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/Tags.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/Tags.json new file mode 100644 index 000000000000..3d05a43e9b20 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/Tags.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/UsageDetailsExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsExpand.json new file mode 100644 index 000000000000..120f4848d2a9 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsExpand.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/UsageDetailsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsList.json new file mode 100644 index 000000000000..788bb0e200e3 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "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/2019-01-01/examples/UsageDetailsListByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListByBillingAccount.json new file mode 100644 index 000000000000..a0d031da26cf --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListByBillingAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "1234" + }, + "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/2019-01-01/examples/UsageDetailsListByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListByDepartment.json new file mode 100644 index 000000000000..0ef7aaa72125 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListByDepartment.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "departmentId": "1234" + }, + "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/2019-01-01/examples/UsageDetailsListByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListByEnrollmentAccount.json new file mode 100644 index 000000000000..89fe0bdfc151 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListByEnrollmentAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "enrollmentAccountId": "1234" + }, + "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/2019-01-01/examples/UsageDetailsListByManagementGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListByManagementGroup.json new file mode 100644 index 000000000000..ca3071b8dbc5 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListByManagementGroup.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "managementGroupForTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180801/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/201808", + "usageStart": "2018-08-13T00:00:00Z", + "usageEnd": "2018-08-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" + } + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/20180801/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201808", + "usageStart": "2018-08-13T00:00:00Z", + "usageEnd": "2018-08-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00120, + "billableQuantity": 0.00128, + "pretaxCost": 0.26, + "isEstimated": false, + "meterId": "11111111-1111-1111-1111-111111111111", + "partNumber":"Part Number 1", + "resourceGuid":"11111111-1111-1111-1111-111111111111", + "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/2019-01-01/examples/UsageDetailsListFilterByTag.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListFilterByTag.json new file mode 100644 index 000000000000..ded1a599fae3 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListFilterByTag.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$filter": "tags eq 'dev:tools'" + }, + "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": { + "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/2019-01-01/examples/UsageDetailsListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriod.json new file mode 100644 index 000000000000..3eea12eac6cb --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriod.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/UsageDetailsListForBillingPeriodByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodByBillingAccount.json new file mode 100644 index 000000000000..2033b0f92d2f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodByBillingAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/UsageDetailsListForBillingPeriodByDepartment.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodByDepartment.json new file mode 100644 index 000000000000..43cb2fbbb211 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodByDepartment.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json new file mode 100644 index 000000000000..d77dd048f2dc --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodByEnrollmentAccount.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/UsageDetailsListForBillingPeriodByManagementGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodByManagementGroup.json new file mode 100644 index 000000000000..fac6199afd12 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodByManagementGroup.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "managementGroupForTest", + "billingPeriodName": "201807" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/20180701/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/201807", + "usageStart": "2018-07-13T00:00:00Z", + "usageEnd": "2018-07-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" + } + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/20180701/providers/Microsoft.Consumption/usageDetails/usageDetailsId1", + "name": "usageDetailsId1", + "type": "Microsoft.Consumption/usageDetails", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201807", + "usageStart": "2018-07-13T00:00:00Z", + "usageEnd": "2018-07-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "instanceLocation": "eastasia", + "currency": "USD", + "usageQuantity": 0.00120, + "billableQuantity": 0.00128, + "pretaxCost": 0.26, + "isEstimated": false, + "meterId": "11111111-1111-1111-1111-111111111111", + "partNumber":"Part Number 1", + "resourceGuid":"11111111-1111-1111-1111-111111111111", + "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/2019-01-01/examples/UsageDetailsListForBillingPeriodGroupByTag.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodGroupByTag.json new file mode 100644 index 000000000000..d9a827842424 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListForBillingPeriodGroupByTag.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/2019-01-01/examples/UsageDetailsListGroupByTagDate.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListGroupByTagDate.json new file mode 100644 index 000000000000..6e2f7d1e42d7 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-01-01/examples/UsageDetailsListGroupByTagDate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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.go.md b/specification/consumption/resource-manager/readme.go.md index 46dadcc2948b..2cd5284033ad 100644 --- a/specification/consumption/resource-manager/readme.go.md +++ b/specification/consumption/resource-manager/readme.go.md @@ -21,6 +21,7 @@ batch: - tag: package-2018-06 - tag: package-2018-08 - tag: package-2018-10 + - tag: package-2019-01 ``` @@ -96,3 +97,11 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-01' && $(go) +output-folder: $(go-sdk-folder)/services/consumption/mgmt/2019-01-01/consumption +``` \ No newline at end of file diff --git a/specification/consumption/resource-manager/readme.md b/specification/consumption/resource-manager/readme.md index 8a253969a640..4a583b834696 100644 --- a/specification/consumption/resource-manager/readme.md +++ b/specification/consumption/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Consumption. - - --- + ## Getting Started + To build the SDK for Consumption, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,20 +15,29 @@ To build the SDK for Consumption, simply [Install AutoRest](https://aka.ms/autor To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the Consumption API. ``` yaml openapi-type: arm -tag: package-2018-10 +tag: package-2019-01 ``` + +### Tag: package-2019-01 + +These settings apply only when `--tag=package-2019-01` is specified on the command line. + +```yaml $(tag) == 'package-2019-01' +input-file: + - Microsoft.Consumption/stable/2019-01-01/consumption.json +``` ### Tag: package-2017-11 These settings apply only when `--tag=package-2017-11` is specified on the command line. @@ -39,6 +48,7 @@ input-file: ``` --- + ### Tag: package-2018-01 These settings apply only when `--tag=package-2018-01` is specified on the command line. @@ -49,6 +59,7 @@ input-file: ``` --- + ### Tag: package-2018-03 These settings apply only when `--tag=package-2018-03` is specified on the command line. @@ -59,6 +70,7 @@ input-file: ``` --- + ### Tag: package-2018-05 These settings apply only when `--tag=package-2018-05` is specified on the command line. @@ -69,6 +81,7 @@ input-file: ``` --- + ### Tag: package-2018-06 These settings apply only when `--tag=package-2018-06` is specified on the command line. @@ -79,6 +92,7 @@ input-file: ``` --- + ### Tag: package-2018-08 These settings apply only when `--tag=package-2018-08` is specified on the command line. @@ -89,6 +103,7 @@ input-file: ``` --- + ### Tag: package-2018-10 These settings apply only when `--tag=package-2018-10` is specified on the command line. @@ -99,6 +114,7 @@ input-file: ``` ## Suppression + ``` yaml directive: - suppress: R2059 @@ -108,6 +124,7 @@ directive: ``` --- + ### Tag: package-2017-04-preview These settings apply only when `--tag=package-2017-04-preview` is specified on the command line. @@ -118,6 +135,7 @@ input-file: ``` --- + ### Tag: package-2017-12-preview These settings apply only when `--tag=package-2017-12-preview` is specified on the command line. @@ -128,8 +146,8 @@ input-file: ``` --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -140,6 +158,7 @@ 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-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby @@ -147,7 +166,6 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_consumption'] ``` - ## C# These settings apply only when `--csharp` is specified on the command line. @@ -179,11 +197,13 @@ python: 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-consumption/azure/mgmt/consumption ``` + ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true @@ -212,11 +232,11 @@ batch: - 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-2018-08 - tag: package-2018-10 + - tag: package-2019-01 ``` ### Tag: package-2017-04-preview and java @@ -269,6 +289,16 @@ java: output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2018_03_31 regenerate-manager: true generate-interface: true +directive: + - rename-model: + from: CostTags + to: CostTagsModel + - rename-model: + from: Tags + to: TagsModel + - rename-model: + from: ReservationRecommendations + to: ReservationRecommendationsModel ``` ### Tag: package-2017-12-preview and java @@ -336,3 +366,15 @@ regenerate-manager: true generate-interface: true ``` +### Tag: package-2019-01 and java + +These settings apply only when `--tag=package-2019-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2019-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.consumption.v2019_01_01 + output-folder: $(azure-libraries-for-java-folder)/consumption/resource-manager/v2019_01_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/consumption/resource-manager/readme.ruby.md b/specification/consumption/resource-manager/readme.ruby.md index 802d572a2438..b2be290ac9fe 100644 --- a/specification/consumption/resource-manager/readme.ruby.md +++ b/specification/consumption/resource-manager/readme.ruby.md @@ -12,12 +12,23 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2019-01 - tag: package-2018-01 - tag: package-2017-12-preview - tag: package-2017-11 - tag: package-2017-04-preview ``` +### Tag: package-2019-01 and ruby + +These settings apply only when `--tag=package-2019-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-01' && $(ruby) +namespace: "Azure::Consumption::Mgmt::V2019_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_consumption/lib +``` + ### Tag: package-2018-01 and ruby These settings apply only when `--tag=package-2018-01 --ruby` is specified on the command line. diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json index 6ea6800444d3..53f5a497b424 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json @@ -760,11 +760,6 @@ "$ref": "#/definitions/SourceTriggerDescriptor", "description": "The source trigger that caused the run." }, - "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 run will happen." @@ -773,6 +768,17 @@ "$ref": "#/definitions/AgentProperties", "description": "The machine configuration of the run agent." }, + "sourceRegistryAuth": { + "description": "The scope of the credentials that were used to login to the source registry during this run.", + "type": "string" + }, + "customRegistries": { + "description": "The list of custom registries that were logged in during this run.", + "type": "array", + "items": { + "type": "string" + } + }, "provisioningState": { "description": "The provisioning state of a run.", "enum": [ @@ -788,6 +794,11 @@ "name": "ProvisioningState", "modelAsString": true } + }, + "isArchiveEnabled": { + "description": "The value that indicates whether archiving is enabled or not.", + "default": false, + "type": "boolean" } } }, @@ -1141,6 +1152,10 @@ "trigger": { "$ref": "#/definitions/TriggerProperties", "description": "The properties that describe all triggers for the task." + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The properties that describes a set of credentials that will be used when this run is invoked." } } }, @@ -1198,6 +1213,23 @@ } } }, + "Credentials": { + "description": "The parameters that describes a set of credentials that will be used when a run is invoked.", + "type": "object", + "properties": { + "sourceRegistry": { + "$ref": "#/definitions/SourceRegistryCredentials", + "description": "Describes the credential parameters for accessing the source registry." + }, + "customRegistries": { + "description": "Describes the credential parameters for accessing other custom registries. The key\r\nfor the dictionary item will be the registry login server (myregistry.azurecr.io) and\r\nthe value of the item will be the registry credentials for accessing the registry.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomRegistryCredentials" + } + } + } + }, "BaseImageDependency": { "description": "Properties that describe a base image dependency.", "type": "object", @@ -1316,6 +1348,38 @@ } } }, + "SourceRegistryCredentials": { + "description": "Describes the credential parameters for accessing the source registry.", + "type": "object", + "properties": { + "loginMode": { + "description": "The authentication mode which determines the source registry login scope. The credentials for the source registry\r\nwill be generated using the given scope. These credentials will be used to login to\r\nthe source registry during the run.", + "enum": [ + "None", + "Default" + ], + "type": "string", + "x-ms-enum": { + "name": "SourceRegistryLoginMode", + "modelAsString": true + } + } + } + }, + "CustomRegistryCredentials": { + "description": "Describes the credentials that will be used to access a custom registry during a run.", + "type": "object", + "properties": { + "userName": { + "$ref": "#/definitions/SecretObject", + "description": "The username for logging into the custom registry." + }, + "password": { + "$ref": "#/definitions/SecretObject", + "description": "The password for logging into the custom registry. The password is a secret \r\nobject that allows multiple ways of providing the value for it." + } + } + }, "SourceProperties": { "description": "The properties of the source code repository.", "required": [ @@ -1350,6 +1414,27 @@ } } }, + "SecretObject": { + "description": "Describes the properties of a secret object value.", + "type": "object", + "properties": { + "value": { + "description": "The value of the secret. The format of this value will be determined\r\nbased on the type of the secret object. If the type is Opaque, the value will be\r\nused as is without any modification.", + "type": "string" + }, + "type": { + "description": "The type of the secret object which determines how the value of the secret object has to be\r\ninterpreted.", + "enum": [ + "Opaque" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretObjectType", + "modelAsString": true + } + } + } + }, "AuthInfo": { "description": "The authorization properties for accessing the source code repository.", "required": [ @@ -1443,6 +1528,10 @@ "trigger": { "$ref": "#/definitions/TriggerUpdateParameters", "description": "The properties for updating trigger properties." + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The parameters that describes a set of credentials that will be used when this run is invoked." } } }, @@ -1777,6 +1866,10 @@ "description": "The Docker file path relative to the source location.", "type": "string" }, + "target": { + "description": "The name of the target build stage for the docker build.", + "type": "string" + }, "arguments": { "description": "The collection of override arguments to be used when executing the run.", "type": "array", @@ -1803,6 +1896,10 @@ "sourceLocation": { "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", "type": "string" + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The properties that describes a set of credentials that will be used when this run is invoked." } }, "x-ms-discriminator-value": "DockerBuildRequest" @@ -1878,6 +1975,10 @@ "sourceLocation": { "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", "type": "string" + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The properties that describes a set of credentials that will be used when this run is invoked." } }, "x-ms-discriminator-value": "FileTaskRunRequest" @@ -1980,6 +2081,10 @@ "sourceLocation": { "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", "type": "string" + }, + "credentials": { + "$ref": "#/definitions/Credentials", + "description": "The properties that describes a set of credentials that will be used when this run is invoked." } }, "x-ms-discriminator-value": "EncodedTaskRunRequest" @@ -2017,6 +2122,10 @@ "description": "The Docker file path relative to the source context.", "type": "string" }, + "target": { + "description": "The name of the target build stage for the docker build.", + "type": "string" + }, "arguments": { "description": "The collection of override arguments to be used when executing this build step.", "type": "array", @@ -2121,6 +2230,10 @@ "items": { "$ref": "#/definitions/Argument" } + }, + "target": { + "description": "The name of the target build stage for the docker build.", + "type": "string" } }, "x-ms-discriminator-value": "Docker" diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_Task_WithCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_Task_WithCustomCredentials.json new file mode 100644 index 000000000000..4eafc8ac646d --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_Task_WithCustomCredentials.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-09-01", + "runRequest": { + "type": "TaskRunRequest", + "values": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "taskName": "myTask", + "credentials": { + "sourceRegistry": { + "loginMode": "Default" + }, + "customRegistries": { + "myregistry.azurecr.io": { + "userName": { + "type": "Opaque", + "value": "reg1" + }, + "password": { + "type": "Opaque", + "value": "***" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "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/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_WithCustomCredentials.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_WithCustomCredentials.json new file mode 100644 index 000000000000..ecd8d6c3b889 --- /dev/null +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/examples/RegistriesScheduleRun_WithCustomCredentials.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "myResourceGroup", + "registryName": "myRegistry", + "api-version": "2018-09-01", + "runRequest": { + "type": "DockerBuildRequest", + "isArchiveEnabled": true, + "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", + "arguments": [ + { + "name": "mytestargument", + "value": "mytestvalue", + "isSecret": false + }, + { + "name": "mysecrettestargument", + "value": "mysecrettestvalue", + "isSecret": true + } + ], + "isPushEnabled": true, + "platform": { + "os": "Linux", + "architecture": "amd64" + }, + "agentConfiguration": { + "cpu": 2 + }, + "dockerFilePath": "DockerFile", + "target": "stage1", + "credentials": { + "sourceRegistry": { + "loginMode": "Default" + }, + "customRegistries": { + "myregistry.azurecr.io": { + "userName": { + "Type": "Opaque", + "Value": "reg1" + }, + "password": { + "Type": "Opaque", + "Value": "***" + } + }, + "myregistry2.azurecr.io": { + "userName": { + "Type": "Opaque", + "Value": "reg2" + }, + "password": { + "Type": "Opaque", + "Value": "***" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "runId": "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/runs/0accec26-d6de-4757-8e74-d080f38eaaab", + "name": "0accec26-d6de-4757-8e74-d080f38eaaab", + "type": "Microsoft.ContainerRegistry/registries/run" + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersCreate_Update.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersCreate_Update.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersCreate_Update.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersDelete.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersDelete.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersDelete.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGet.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGet.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGet.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetAccessProfile.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetAccessProfile.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetAccessProfile.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetUpgradeProfile.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetUpgradeProfile.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetUpgradeProfile.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersList.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersList.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersList.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListByResourceGroup.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListByResourceGroup.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListByResourceGroup.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListClusterCredentialResult.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListClusterCredentialResult.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListClusterCredentialResult.json diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..a260ce1dcce0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": {} + } + } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..93807439e1dd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": {} + } + } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersUpdateTags.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersUpdateTags.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersUpdateTags.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json similarity index 98% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json index 8dd8e8005aee..c49e0b0eaa01 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json @@ -113,6 +113,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." } ], @@ -154,6 +155,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -199,6 +201,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -251,6 +254,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -296,6 +300,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -341,6 +346,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -384,6 +390,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -443,6 +450,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -496,6 +504,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -522,15 +531,15 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile":{ - "post":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { "tags": [ "ManagedClusters" ], "operationId": "ManagedClusters_ResetServicePrincipalProfile", "summary": "Reset Service Principal Profile of a managed cluster.", "description": "Update the service principal Profile for a managed cluster.", - "parameters":[ + "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, @@ -542,6 +551,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -559,20 +569,14 @@ "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" }, "description": "Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster." - } + } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ManagedCluster" - } - }, + "description": "OK" + }, "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/ManagedCluster" - } + "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", @@ -589,15 +593,15 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile":{ - "post":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { "tags": [ "ManagedClusters" ], "operationId": "ManagedClusters_ResetAADProfile", "summary": "Reset AAD Profile of a managed cluster.", "description": "Update the AAD Profile for a managed cluster.", - "parameters":[ + "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, @@ -609,6 +613,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -626,20 +631,14 @@ "$ref": "#/definitions/ManagedClusterAADProfile" }, "description": "Parameters supplied to the Reset AAD Profile operation for a Managed Cluster." - } + } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ManagedCluster" - } + "description": "OK" }, "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/ManagedCluster" - } + "description": "Accepted" }, "default": { "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", @@ -650,11 +649,11 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Reset Service Principal Profile": { + "Reset AAD Profile": { "$ref": "./examples/ManagedClustersResetAADProfile.json" } } - } + } } }, "definitions": { @@ -1079,7 +1078,7 @@ "$ref": "#/definitions/OSType", "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." }, - "maxCount":{ + "maxCount": { "type": "integer", "format": "int32", "description": "Maximum number of nodes for auto-scaling" @@ -1089,7 +1088,7 @@ "format": "int32", "description": "Minimum number of nodes for auto-scaling" }, - "enableAutoScaling":{ + "enableAutoScaling": { "type": "boolean", "description": "Whether to enable auto-scaler" }, @@ -1105,7 +1104,7 @@ ], "description": "Profile for the container service agent pool." }, - "AgentPoolType":{ + "AgentPoolType": { "type": "string", "enum": [ "VirtualMachineScaleSets", @@ -1544,14 +1543,15 @@ }, "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." }, - "CredentialResults":{ + "CredentialResults": { "properties": { "kubeconfigs": { - "type" : "array", + "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/CredentialResult" - } + }, + "description": "Base64-encoded Kubernetes configuration file." } }, "description": "The list of credential result response." @@ -1559,7 +1559,7 @@ "CredentialResult": { "type": "object", "properties": { - "name":{ + "name": { "type": "string", "readOnly": true, "description": "The name of the credential." diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersCreate_Update.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersCreate_Update.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersCreate_Update.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersDelete.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersDelete.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersDelete.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersGet.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersGet.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersGet.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersList.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersList.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersList.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersListByResourceGroup.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersListByResourceGroup.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersListByResourceGroup.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersUpdateTags.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersUpdateTags.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersUpdateTags.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json similarity index 95% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json index 30adc9533b33..cdef91638972 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json @@ -6,12 +6,20 @@ "version": "2018-09-30-preview" }, "host": "management.azure.com", - "schemes": ["https"], - "consumes": ["application/json"], - "produces": ["application/json"], + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "security": [ { - "azure_auth": ["user_impersonation"] + "azure_auth": [ + "user_impersonation" + ] } ], "securityDefinitions": { @@ -28,7 +36,9 @@ "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/openShiftManagedClusters": { "get": { - "tags": ["OpenShiftManagedClusters"], + "tags": [ + "OpenShiftManagedClusters" + ], "operationId": "OpenShiftManagedClusters_List", "summary": "Gets a list of OpenShift managed clusters in the specified subscription.", "description": "Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.", @@ -60,7 +70,9 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/openShiftManagedClusters": { "get": { - "tags": ["OpenShiftManagedClusters"], + "tags": [ + "OpenShiftManagedClusters" + ], "operationId": "OpenShiftManagedClusters_ListByResourceGroup", "summary": "Lists OpenShift managed clusters in the specified subscription and resource group.", "description": "Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.", @@ -76,6 +88,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." } ], @@ -99,7 +112,9 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/openShiftManagedClusters/{resourceName}": { "get": { - "tags": ["OpenShiftManagedClusters"], + "tags": [ + "OpenShiftManagedClusters" + ], "operationId": "OpenShiftManagedClusters_Get", "summary": "Gets a OpenShift managed cluster.", "description": "Gets the details of the managed OpenShift cluster with a specified resource group and name.", @@ -115,6 +130,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -146,7 +162,9 @@ } }, "put": { - "tags": ["OpenShiftManagedClusters"], + "tags": [ + "OpenShiftManagedClusters" + ], "operationId": "OpenShiftManagedClusters_CreateOrUpdate", "summary": "Creates or updates an OpenShift managed cluster.", "description": "Creates or updates a OpenShift managed cluster with the specified configuration for agents and OpenShift version.", @@ -162,6 +180,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -209,7 +228,9 @@ } }, "patch": { - "tags": ["OpenShiftManagedClusters"], + "tags": [ + "OpenShiftManagedClusters" + ], "operationId": "OpenShiftManagedClusters_UpdateTags", "summary": "Updates tags on an OpenShift managed cluster.", "description": "Updates an OpenShift managed cluster with the specified tags.", @@ -225,6 +246,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -266,7 +288,9 @@ } }, "delete": { - "tags": ["OpenShiftManagedClusters"], + "tags": [ + "OpenShiftManagedClusters" + ], "operationId": "OpenShiftManagedClusters_Delete", "summary": "Deletes an OpenShift managed cluster.", "description": "Deletes the OpenShift managed cluster with a specified resource group and name.", @@ -282,6 +306,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -337,7 +362,10 @@ "location": { "type": "string", "description": "Resource location", - "x-ms-mutability": ["read", "create"] + "x-ms-mutability": [ + "read", + "create" + ] }, "tags": { "type": "object", @@ -347,7 +375,9 @@ "description": "Resource tags" } }, - "required": ["location"], + "required": [ + "location" + ], "x-ms-azure-resource": true }, "CloudError": { @@ -441,7 +471,10 @@ "OSType": { "type": "string", "default": "Linux", - "enum": ["Linux", "Windows"], + "enum": [ + "Linux", + "Windows" + ], "x-ms-enum": { "name": "OSType", "modelAsString": true @@ -493,7 +526,10 @@ }, "OpenShiftAgentPoolProfileRole": { "type": "string", - "enum": ["compute", "infra"], + "enum": [ + "compute", + "infra" + ], "x-ms-enum": { "name": "OpenShiftAgentPoolProfileRole", "modelAsString": true @@ -524,7 +560,10 @@ "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." } }, - "required": ["count", "vmSize"], + "required": [ + "count", + "vmSize" + ], "description": "OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs." }, "OpenShiftManagedClusterAgentPoolProfile": { @@ -556,7 +595,11 @@ "$ref": "#/definitions/OpenShiftAgentPoolProfileRole" } }, - "required": ["name", "count", "vmSize"], + "required": [ + "name", + "count", + "vmSize" + ], "description": "Defines the configuration of the OpenShift cluster VMs." }, "OpenShiftManagedClusterIdentityProvider": { @@ -630,7 +673,9 @@ "description": "Configures OpenShift authentication." } }, - "required": ["openShiftVersion"], + "required": [ + "openShiftVersion" + ], "description": "Properties of the OpenShift managed cluster." }, "OpenShiftManagedCluster": { @@ -656,7 +701,9 @@ }, "OpenShiftManagedClusterBaseIdentityProvider": { "discriminator": "kind", - "required": ["kind"], + "required": [ + "kind" + ], "properties": { "kind": { "type": "string", diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesCreate_Update.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesCreate_Update.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesCreate_Update.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesDelete.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesDelete.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesDelete.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesGet.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesGet.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesGet.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesList.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesList.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesList.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesListByResourceGroup.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesListByResourceGroup.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-01-31/examples/ContainerServicesListByResourceGroup.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServiceCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServiceCreate_Update.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServiceCreate_Update.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServiceCreate_Update.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServiceDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServiceDelete.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServiceDelete.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServiceDelete.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesGet.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesGet.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesGet.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesList.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesList.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesList.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesListByResourceGroup.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesListByResourceGroup.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-07-01/examples/ContainerServicesListByResourceGroup.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersAccessProfilesGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersAccessProfilesGet.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersAccessProfilesGet.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersAccessProfilesGet.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersCreate_Update.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersCreate_Update.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersCreate_Update.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersDelete.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersDelete.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersDelete.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGet.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGet.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGet.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetAccessProfile.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetAccessProfile.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetAccessProfile.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetUpgradeProfile.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetUpgradeProfile.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersGetUpgradeProfile.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersList.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersList.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersList.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersListByResourceGroup.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersListByResourceGroup.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/examples/ManagedClustersListByResourceGroup.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-09-30/examples/ContainerServiceListOrchestrators.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-09-30/examples/ContainerServiceListOrchestrators.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-09-30/examples/ContainerServiceListOrchestrators.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-09-30/examples/ContainerServiceListOrchestrators.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersCreate_Update.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersCreate_Update.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersCreate_Update.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersDelete.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersDelete.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersDelete.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGet.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGet.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGet.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetAccessProfile.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetAccessProfile.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetAccessProfile.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetUpgradeProfile.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetUpgradeProfile.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersGetUpgradeProfile.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersList.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersList.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersList.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListByResourceGroup.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListByResourceGroup.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListByResourceGroup.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListClusterCredentialResult.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListClusterCredentialResult.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersListClusterCredentialResult.json diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..fbe01c93ed3b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": {} + } + } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..985595c62666 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": {} + } + } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersUpdateTags.json similarity index 100% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersUpdateTags.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersUpdateTags.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json similarity index 98% rename from specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json rename to specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json index 6ce659b61557..b12567ed2abf 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json @@ -113,6 +113,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." } ], @@ -154,6 +155,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -199,6 +201,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -251,6 +254,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -296,6 +300,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -341,6 +346,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -384,6 +390,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -443,6 +450,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -496,6 +504,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -522,15 +531,15 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile":{ - "post":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { "tags": [ "ManagedClusters" ], "operationId": "ManagedClusters_ResetServicePrincipalProfile", "summary": "Reset Service Principal Profile of a managed cluster.", "description": "Update the service principal Profile for a managed cluster.", - "parameters":[ + "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, @@ -542,6 +551,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -559,20 +569,14 @@ "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" }, "description": "Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster." - } + } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ManagedCluster" - } + "description": "OK" }, "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/ManagedCluster" - } + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -583,15 +587,15 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile":{ - "post":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { "tags": [ "ManagedClusters" ], "operationId": "ManagedClusters_ResetAADProfile", "summary": "Reset AAD Profile of a managed cluster.", "description": "Update the AAD Profile for a managed cluster.", - "parameters":[ + "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, @@ -603,6 +607,7 @@ "in": "path", "required": true, "type": "string", + "minLength": 1, "description": "The name of the resource group." }, { @@ -620,29 +625,23 @@ "$ref": "#/definitions/ManagedClusterAADProfile" }, "description": "Parameters supplied to the Reset AAD Profile operation for a Managed Cluster." - } + } ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ManagedCluster" - } + "description": "OK" }, "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/ManagedCluster" - } + "description": "Accepted" } }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Reset Service Principal Profile": { + "Reset AAD Profile": { "$ref": "./examples/ManagedClustersResetAADProfile.json" } } - } + } } }, "definitions": { @@ -1506,14 +1505,15 @@ }, "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." }, - "CredentialResults":{ + "CredentialResults": { "properties": { "kubeconfigs": { - "type" : "array", + "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/CredentialResult" - } + }, + "description": "Base64-encoded Kubernetes configuration file." } }, "description": "The list of credential result response." @@ -1521,7 +1521,7 @@ "CredentialResult": { "type": "object", "properties": { - "name":{ + "name": { "type": "string", "readOnly": true, "description": "The name of the credential." diff --git a/specification/containerservices/resource-manager/readme.go.md b/specification/containerservice/resource-manager/readme.go.md similarity index 100% rename from specification/containerservices/resource-manager/readme.go.md rename to specification/containerservice/resource-manager/readme.go.md diff --git a/specification/containerservices/resource-manager/readme.md b/specification/containerservice/resource-manager/readme.md similarity index 99% rename from specification/containerservices/resource-manager/readme.md rename to specification/containerservice/resource-manager/readme.md index 6efba03d7355..236a66b24f06 100644 --- a/specification/containerservices/resource-manager/readme.md +++ b/specification/containerservice/resource-manager/readme.md @@ -8,7 +8,7 @@ The ContainerServices RPv2 consists of two similar services: ContainerServices a Each service has its own swagger spec. The two specs are united by running `autorest` in this directory, which will use this readme.md -file for configuration options. It will generate a single *azure-mgmt-containerservices* client +file for configuration options. It will generate a single *azure-mgmt-containerservice* client library. --- diff --git a/specification/containerservices/resource-manager/readme.nodejs.md b/specification/containerservice/resource-manager/readme.nodejs.md similarity index 100% rename from specification/containerservices/resource-manager/readme.nodejs.md rename to specification/containerservice/resource-manager/readme.nodejs.md diff --git a/specification/containerservices/resource-manager/readme.python.md b/specification/containerservice/resource-manager/readme.python.md similarity index 100% rename from specification/containerservices/resource-manager/readme.python.md rename to specification/containerservice/resource-manager/readme.python.md diff --git a/specification/containerservices/resource-manager/readme.ruby.md b/specification/containerservice/resource-manager/readme.ruby.md similarity index 100% rename from specification/containerservices/resource-manager/readme.ruby.md rename to specification/containerservice/resource-manager/readme.ruby.md diff --git a/specification/containerservices/resource-manager/readme.typescript.md b/specification/containerservice/resource-manager/readme.typescript.md similarity index 100% rename from specification/containerservices/resource-manager/readme.typescript.md rename to specification/containerservice/resource-manager/readme.typescript.md diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json deleted file mode 100644 index d0191f93e886..000000000000 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "subscriptionId": "subid1", - "resourceGroupName": "rg1", - "resourceName": "clustername1", - "parameters": { - "aadProfile": { - "clientAppID": "clientappid", - "serverAppID": "serverappid", - "serverAppSecret": "serverappsecret", - "tenantID": "tenantid" - } - } - }, - "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" - }, - "aadProfile": { - "clientAppID": "clientappid", - "serverAppID": "serverappid", - "tenantID": "tenantid" - }, - "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" - } - } - } - } - } - } - \ No newline at end of file diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json deleted file mode 100644 index c1f93e9bc5f0..000000000000 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "subscriptionId": "subid1", - "resourceGroupName": "rg1", - "resourceName": "clustername1", - "parameters": { - "servicePrincipalProfile": { - "clientId": "clientid", - "secret": "secret" - } - } - }, - "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" - } - } - } - } - } - } - \ No newline at end of file diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json deleted file mode 100644 index 5b1418a8da45..000000000000 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "api-version": "2018-03-31", - "subscriptionId": "subid1", - "resourceGroupName": "rg1", - "resourceName": "clustername1", - "parameters": { - "aadProfile": { - "clientAppID": "clientappid", - "serverAppID": "serverappid", - "serverAppSecret": "serverappsecret", - "tenantID": "tenantid" - } - } - }, - "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" - }, - "aadProfile": { - "clientAppID": "clientappid", - "serverAppID": "serverappid", - "tenantID": "tenantid" - }, - "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" - } - } - } - } - } - } - \ No newline at end of file diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json deleted file mode 100644 index 6a14e1456664..000000000000 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "api-version": "2018-03-31", - "subscriptionId": "subid1", - "resourceGroupName": "rg1", - "resourceName": "clustername1", - "parameters": { - "servicePrincipalProfile": { - "clientId": "clientid", - "secret": "secret" - } - } - }, - "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" - } - } - } - } - } - } - \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json index 5303e371095c..4adfa0fe88be 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json @@ -3067,7 +3067,8 @@ "description": "The granularity of rows in the report.", "type": "string", "enum": [ - "Daily" + "Daily", + "Hourly" ], "x-ms-enum": { "name": "GranularityType", @@ -3281,11 +3282,13 @@ "description": "The status of the report execution.", "type": "string", "enum": [ - "Queud", + "Queued", "InProgress", "Completed", "Failed", - "Timeout" + "Timeout", + "NewDataNotAvailable", + "DataNotAvailable" ], "x-ms-enum": { "name": "ExecutionStatus", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/costmanagement.json new file mode 100644 index 000000000000..2b7d3f57b3be --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/costmanagement.json @@ -0,0 +1,2872 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-03-01-preview", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ListByBillingAccount", + "description": "Lists the dimensions by billingAccount Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "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 category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "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 + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ListByEnrollmentAccount", + "description": "Lists the dimensions by Enrollment Account Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "EnrollmentAccountDimensionsList": { + "$ref": "./examples/EnrollmentAccountDimensionsList.json" + }, + "EnrollmentAccountDimensionsListExpandAndTop": { + "$ref": "./examples/EnrollmentAccountDimensionsListExpandAndTop.json" + }, + "EnrollmentAccountDimensionsListWithFilter": { + "$ref": "./examples/EnrollmentAccountDimensionsListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "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 + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ListByDepartment", + "description": "Lists the dimensions by Department Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "DepartmentDimensionsList": { + "$ref": "./examples/DepartmentDimensionsList.json" + }, + "DepartmentDimensionsListExpandAndTop": { + "$ref": "./examples/DepartmentDimensionsListExpandAndTop.json" + }, + "DepartmentDimensionsListWithFilter": { + "$ref": "./examples/DepartmentDimensionsListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "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 + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ListByManagementGroup", + "description": "Lists the dimensions by managementGroup Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ManagementGroupDimensionsList": { + "$ref": "./examples/ManagementGroupDimensionsList.json" + }, + "ManagementGroupDimensionsListExpandAndTop": { + "$ref": "./examples/ManagementGroupDimensionsListExpandAndTop.json" + }, + "ManagementGroupDimensionsListWithFilter": { + "$ref": "./examples/ManagementGroupDimensionsListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "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": "Dimensions_ListBySubscription", + "description": "Lists the dimensions by subscription Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "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 category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "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": "Query_UsageBySubscription", + "description": "Query the usage data for subscriptionId.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "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}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageBySubscription", + "description": "Forecast the usage data for subscriptionId.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionForecast": { + "$ref": "./examples/SubscriptionForecast.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/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ListByResourceGroup", + "description": "Lists the dimensions by resource group Id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "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 category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "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/Query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_UsageByResourceGroup", + "description": "Query the usage data for subscriptionId and resource group.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "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 + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByResourceGroup", + "description": "Forecast the usage data for subscriptionId and resource group.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupForecast": { + "$ref": "./examples/ResourceGroupForecast.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": "Query_UsageByBillingAccount", + "description": "Query the usage data for billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountQuery": { + "$ref": "./examples/BillingAccountQuery.json" + }, + "BillingAccountQueryGroupingUsage": { + "$ref": "./examples/BillingAccountQueryGrouping.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 + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByBillingAccount", + "description": "Forecast the usage data for billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountForecast": { + "$ref": "./examples/BillingAccountForecast.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 + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/Query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_UsageByEnrollmentAccount", + "description": "Query the usage data for an enrollment account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "EnrollmentAccountQuery": { + "$ref": "./examples/EnrollmentAccountQuery.json" + }, + "EnrollmentAccountQueryGroupingUsage": { + "$ref": "./examples/EnrollmentAccountQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "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}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByEnrollmentAccount", + "description": "Forecast the usage data for an enrollment account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "EnrollmentAccountForecast": { + "$ref": "./examples/EnrollmentAccountForecast.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "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}/departments/{departmentId}/providers/Microsoft.CostManagement/Query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_UsageByDepartment", + "description": "Query the usage data for department.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "DepartmentQuery": { + "$ref": "./examples/DepartmentQuery.json" + }, + "DepartmentQueryGroupingUsage": { + "$ref": "./examples/DepartmentQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "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}/departments/{departmentId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByDepartment", + "description": "Forecast the usage data for department.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "DepartmentForecast": { + "$ref": "./examples/DepartmentForecast.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "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.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/Query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_UsageByManagmentGroup", + "description": "Lists the usage data for management group.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ManagementGroupQuery": { + "$ref": "./examples/ManagementGroupQuery.json" + }, + "ManagementGroupQueryGroupingUsage": { + "$ref": "./examples/ManagementGroupQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "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.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByManagmentGroup", + "description": "Lists the usage data for management group.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ManagementGroupForecast": { + "$ref": "./examples/ManagementGroupForecast.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "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.CostManagement/cloudConnectors": { + "get": { + "tags": [ + "CloudConnectors" + ], + "operationId": "CloudConnector_List", + "description": "List all cloud connector definitions", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "CloudConnector_List": { + "$ref": "./examples/CloudConnectorList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConnectorDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.CostManagement/cloudConnectors/{connectorName}": { + "get": { + "tags": [ + "CloudConnectors" + ], + "operationId": "CloudConnector_Get", + "description": "Get a cloud connector definition", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "CloudConnector_Get": { + "$ref": "./examples/CloudConnectorGet.json" + }, + "CloudConnector_Get_Expand": { + "$ref": "./examples/CloudConnectorGetExpand.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/connectorNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the collectionInfo property. By default, collectionInfo is not included.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConnectorDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CloudConnectors" + ], + "operationId": "CloudConnector_CreateOrUpdate", + "description": "Create or update a cloud connector definition", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "CloudConnector_Put": { + "$ref": "./examples/CloudConnectorPut.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/connectorNameParameter" + }, + { + "name": "connector", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "description": "Connector details" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConnectorDefinition" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/ConnectorDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CloudConnectors" + ], + "operationId": "CloudConnector_Delete", + "description": "Delete a cloud connector definition", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "CloudConnector_Delete": { + "$ref": "./examples/CloudConnectorDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/connectorNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "CloudConnectors" + ], + "operationId": "CloudConnector_Update", + "description": "Update a cloud connector definition", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "CloudConnector_Patch": { + "$ref": "./examples/CloudConnectorPatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/connectorNameParameter" + }, + { + "name": "connector", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectorDefinition" + }, + "description": "Connector details" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConnectorDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/externalBillingAccounts": { + "get": { + "tags": [ + "ExternalBillingAccounts" + ], + "operationId": "ExternalBillingAccount_List", + "description": "List all ExternalBillingAccount definitions", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccount_List": { + "$ref": "./examples/ExternalBillingAccountList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExternalBillingAccountDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}": { + "get": { + "tags": [ + "ExternalBillingAccounts" + ], + "operationId": "ExternalBillingAccount_Get", + "description": "Get a ExternalBillingAccount definition", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccount_Get": { + "$ref": "./examples/ExternalBillingAccountGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/externalBillingAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExternalBillingAccountDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}/externalSubscriptions": { + "get": { + "tags": [ + "ExternalSubscriptions" + ], + "operationId": "ExternalSubscription_ListByExternalBillingAccount", + "description": "List all ExternalSubscriptions by ExternalBillingAccount definitions", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountExternalSubscription_List": { + "$ref": "./examples/ExternalBillingAccountExternalSubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/externalBillingAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExternalSubscriptionDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.CostManagement/externalSubscriptions": { + "get": { + "tags": [ + "ExternalSubscriptions" + ], + "operationId": "ExternalSubscription_List", + "description": "List all ExternalSubscription definitions", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalSubscription_List": { + "$ref": "./examples/ExternalSubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExternalSubscriptionDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}": { + "get": { + "tags": [ + "ExternalSubscriptions" + ], + "operationId": "ExternalSubscription_Get", + "description": "Get an ExternalSubscription definition", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalSubscription_Get": { + "$ref": "./examples/ExternalSubscriptionGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/externalSubscriptionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExternalSubscriptionDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions": { + "get": { + "tags": [ + "ExternalSubscriptions" + ], + "operationId": "ExternalSubscription_ListByManagementGroup", + "description": "List all ExternalSubscription definitions for Management Group", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalSubscription_List": { + "$ref": "./examples/ManagementGroupExternalSubscriptionList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExternalSubscriptionDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}": { + "put": { + "tags": [ + "ExternalSubscriptions" + ], + "operationId": "ExternalSubscription_UpdateByManagementGroup", + "description": "Associates ExternalSubscription with the management group", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ManagementGroupExternalSubscription_Put": { + "$ref": "./examples/ManagementGroupExternalSubscriptionPut.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/externalSubscriptionNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/getEntities": { + "post": { + "tags": [ + "Entities" + ], + "operationId": "Entities_ListByManagementGroup", + "description": "List all entities (Management Groups, Subscriptions, ExternalSubscriptions, etc.) focusing on a particular group for the authenticated user.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/EntityViewParameter" + } + ], + "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/ManagementGroupGetEntities.json" + } + } + } + }, + "/providers/Microsoft.CostManagement/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": { + "ErrorBase": { + "description": "The details of the error.", + "properties": { + "code": { + "type": "string", + "description": "A machine readable error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A human readable error message.", + "readOnly": true + }, + "target": { + "type": "string", + "description": "Indicates which property in the request is responsible for the error.", + "readOnly": true + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "A human readable error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorBase" + } + } + } + }, + "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 + }, + "ReportConfigDefinition": { + "description": "The definition of a report config.", + "properties": { + "type": { + "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.", + "type": "string", + "enum": [ + "Usage" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "WeekToDate", + "MonthToDate", + "YearToDate", + "Custom" + ], + "x-ms-enum": { + "name": "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" + ] + }, + "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", + "Monthly" + ], + "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 up to 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 up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigGrouping" + }, + "maxItems": 2 + }, + "sorting": { + "description": "Array of order by expression to use in the report.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigSorting" + } + }, + "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" + ] + }, + "ReportConfigSorting": { + "description": "The order by expression to be used in the report.", + "properties": { + "direction": { + "description": "Direction of sort.", + "type": "string", + "enum": [ + "Ascending", + "Descending" + ] + }, + "name": { + "description": "The name of the column to sort.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ReportConfigGrouping": { + "description": "The group by expression to be used in the report.", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/ReportConfigColumnType" + }, + "name": { + "description": "The name of the column to group. This version supports subscription lowest possible grain.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "ReportConfigFilter": { + "description": "The filter expression to be used in the report.", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 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 comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In", + "Contains" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "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": { + "description": { + "type": "string" + }, + "filterEnabled": { + "type": "boolean" + }, + "groupingEnabled": { + "type": "boolean" + }, + "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" + } + } + }, + "ConnectorDefinitionListResult": { + "description": "Result of listing connector definitions. It contains a list of available connector definitions in the scope provided.", + "properties": { + "value": { + "description": "The list of connector definitions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ConnectorDefinition" + } + } + } + }, + "ConnectorDefinition": { + "type": "object", + "description": "The Connector model definition", + "properties": { + "kind": { + "type": "string", + "description": "Connector kind (eg aws)" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Connector id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Connector name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Connector type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectorProperties", + "description": "Connector properties" + } + }, + "x-ms-azure-resource": true + }, + "ConnectorProperties": { + "type": "object", + "description": "The properties of a Connector", + "properties": { + "displayName": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Connector DisplayName" + }, + "providerAccountId": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Connector providerAccountId (determined from credentials)", + "readOnly": true + }, + "credentialsKey": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Credentials authentication key (eg AWS ARN)" + }, + "credentialsSecret": { + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Credentials secret (eg AWS ExternalId)" + }, + "reportId": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Identifying source report. (For AWS this is a CUR report name, defined with Daily and with Resources)" + }, + "createdOn": { + "format": "date-time", + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Connector definition creation datetime", + "readOnly": true + }, + "modifiedOn": { + "format": "date-time", + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Connector last modified datetime", + "readOnly": true + }, + "status": { + "enum": [ + "active", + "error", + "suspended" + ], + "x-ms-enum": { + "name": "ConnectorStatus", + "modelAsString": true + }, + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Connector status" + }, + "defaultManagementGroupId": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Default ManagementGroupId" + }, + "subscriptionId": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Billing SubscriptionId" + }, + "billingModel": { + "enum": [ + "trial", + "autoUpgrade", + "premium", + "expired" + ], + "x-ms-enum": { + "name": "ConnectorBillingModel", + "modelAsString": true + }, + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Connector billing model" + }, + "daysTrialRemaining": { + "type": "integer", + "x-nullable": true, + "x-ms-mutability": [ + "read" + ], + "description": "Number of days remaining of trial", + "readOnly": true + }, + "collectionInfo": { + "$ref": "#/definitions/ConnectorCollectionInfo", + "description": "Collection information", + "x-nullable": true, + "readOnly": true + } + } + }, + "ConnectorCollectionInfo": { + "type": "object", + "description": "Collection and ingestion information", + "properties": { + "lastChecked": { + "format": "date-time", + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Last time the data acquisition process initiated connecting to the external provider", + "readOnly": true + }, + "sourceLastUpdated": { + "format": "date-time", + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp)", + "readOnly": true + }, + "lastUpdated": { + "format": "date-time", + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Last time the external data was updated into Azure", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ConnectorCollectionErrorInfo", + "description": "Error information of last collection" + } + } + }, + "ConnectorCollectionErrorInfo": { + "type": "object", + "description": "Details of any error encountered on last collection attempt", + "properties": { + "errorMessage": { + "type": "string", + "description": "Detailed error message", + "readOnly": true + }, + "errorInnerMessage": { + "type": "string", + "description": "External Provider error message", + "readOnly": true + }, + "errorCode": { + "type": "string", + "description": "Short error code", + "readOnly": true + }, + "errorStartTime": { + "format": "date-time", + "type": "string", + "description": "Time the error started occurring (Last time error occurred in lastChecked)", + "readOnly": true + } + } + }, + "ExternalBillingAccountDefinitionListResult": { + "description": "Result of listing ExternalBillingAccount definitions. It contains a list of available ExternalBillingAccount definitions in the scope provided.", + "properties": { + "value": { + "description": "The list of ExternalBillingAccount definitions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExternalBillingAccountDefinition" + } + } + } + }, + "ExternalBillingAccountDefinition": { + "type": "object", + "description": "The ExternalBillingAccount model definition", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ExternalBillingAccount id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "ExternalBillingAccount name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "ExternalBillingAccount type" + }, + "kind": { + "type": "string", + "readOnly": true, + "description": "ExternalBillingAccount kind (eg aws)" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExternalBillingAccountProperties", + "description": "ExternalBillingAccount properties" + } + }, + "x-ms-azure-resource": true + }, + "ExternalBillingAccountProperties": { + "type": "object", + "description": "The properties of a ExternalBillingAccount", + "properties": { + "displayName": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "ExternalBillingAccount DisplayName", + "readOnly": true + }, + "connectorId": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Underlying ConnectorId", + "readOnly": true + } + } + }, + "ExternalSubscriptionDefinitionListResult": { + "description": "Result of listing ExternalSubscription definitions. It contains a list of available ExternalSubscription definitions in the scope provided.", + "properties": { + "value": { + "description": "The list of ExternalSubscription definitions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExternalSubscriptionDefinition" + } + } + } + }, + "ExternalSubscriptionDefinition": { + "type": "object", + "description": "The ExternalSubscription model definition", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ExternalSubscription id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "ExternalSubscription name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "ExternalSubscription type" + }, + "kind": { + "type": "string", + "readOnly": true, + "description": "ExternalSubscription kind (eg aws)" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExternalSubscriptionProperties", + "description": "ExternalSubscription properties" + } + }, + "x-ms-azure-resource": true + }, + "ExternalSubscriptionProperties": { + "type": "object", + "description": "The properties of a ExternalSubscription", + "properties": { + "displayName": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "ExternalSubscription DisplayName", + "readOnly": true + }, + "managementGroupId": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Assigned ManagementGroupId", + "readOnly": true + }, + "externalBillingAccountId": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "description": "Parent ExternalBillingAccountId", + "readOnly": true + } + } + }, + "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 + }, + "kind": { + "type": "string", + "readOnly": true, + "description": "The kind of the resource", + "x-nullable": 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" + } + } + }, + "Permissions": { + "type": "string", + "enum": [ + "noaccess", + "view", + "edit", + "delete" + ], + "description": "The users specific permissions to this item." + }, + "OperationListResult": { + "description": "Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of cost management operations supported by the Microsoft.CostManagement resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Cost management 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.CostManagement.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: Dimensions, Query.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "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 2019-03-01-preview" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "description": "ManagementGroup ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "Enrollment Account ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure Resource Group Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "connectorNameParameter": { + "name": "connectorName", + "in": "path", + "description": "Connector Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "externalBillingAccountNameParameter": { + "name": "externalBillingAccountName", + "in": "path", + "description": "External Billing Account Name. (eg 'aws-{PayerAccountId}')", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "externalSubscriptionNameParameter": { + "name": "externalSubscriptionName", + "in": "path", + "description": "External Subscription Name. (eg 'aws-{UsageAccountId}')", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityViewParameter": { + "name": "$view", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "FullHierarchy", + "GroupsOnly", + "SubscriptionsOnly", + "ExternalSubscriptionsOnly", + "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/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsList.json new file mode 100644 index 000000000000..2148d6fc447b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 3, + "category": "SubscriptionGuid", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Subscription Guid", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceType_2018-12-01_2018-12-31", + "name": "dimensions_ResourceType_2018-12-01_2018-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "Account Name", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..261219b6d68d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceType_2018-12-31_2018-12-31_5", + "name": "dimensions_ResourceType_2018-12-01_2018-12-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-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..02adf3719dc8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountDimensionsListWithFilter.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.consumption/dimensions_ResourceId_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceId_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/ccmapi/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.Consumption/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-03-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountForecast.json new file mode 100644 index 000000000000..0d2b125d34e1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountForecast.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "SubscriptionName", + "operator": "In", + "values": [ + "Azure Dev", + "Azure Prod", + "Azure PPE" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "DepartmentName", + "operator": "In", + "values": [ + "Azure Dept" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Forecast/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Forecast", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Forecast?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + 20180831, + "Actual", + "USD" + ], + [ + 20.41979233490323, + 20180930, + "Actual", + "USD" + ], + [ + 21.322216562625452, + 20181031, + "Actual", + "USD" + ], + [ + 22.545363672276532, + 20180831, + "Actual", + "USD" + ], + [ + 23.41979675590323, + 20180930, + "Forecast", + "USD" + ], + [ + 24.359416562626652, + 20181031, + "Forecast", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountQuery.json new file mode 100644 index 000000000000..8c6186516458 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountQuery.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "SubscriptionName", + "operator": "In", + "values": [ + "Azure Dev", + "Azure Prod", + "Azure PPE" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "DepartmentName", + "operator": "In", + "values": [ + "Azure Dept" + ] + } + } + ] + } + } + } + }, + "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=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + 20180831, + "USD" + ], + [ + 173.41979241290323, + 20180930, + "USD" + ], + [ + 20.359416562625452, + 20181031, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountQueryGrouping.json new file mode 100644 index 000000000000..df58f39472b5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/BillingAccountQueryGrouping.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-10-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "SubscriptionName" + } + ] + } + } + }, + "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=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "SubscriptionName", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "Trial Subscription", + "USD" + ], + [ + 173.41979241290323, + "DEV Subscription", + "USD" + ], + [ + 20.359416562625452, + "Cost Management Subscrioption", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorDelete.json new file mode 100644 index 000000000000..6000c2609293 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorDelete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "connectorName": "12345678-9012-3456-7890-111111111111" + }, + "responses": { + "200": { + } + } +} + diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorGet.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorGet.json new file mode 100644 index 000000000000..8805252a8b85 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "connectorName": "12345678-9012-3456-7890-111111111111" + }, + "responses": { + "200": { + "body": { + "kind": "aws", + "id": "/providers/Microsoft.CostManagement/cloudConnectors/12345678-9012-3456-7890-111111111111", + "name": "12345678-9012-3456-7890-111111111111", + "type": "Microsoft.CostManagement/cloudConnectors", + "properties": { + "displayName": "AWS-Consolidated-1", + "providerAccountId": "123456789012", + "credentialsKey": "arn:aws:iam::123456789012:role/AzureCostManagementRole", + "reportId": "HourlyWithResources", + "createdOn": "2018-05-15T13:25:48Z", + "modifiedOn": "2018-05-23T09:21:11Z", + "status": "active", + "defaultManagementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ", + "subscriptionId": "22222222-3333-4444-1111-777777777777", + "billingModel": "autoUpgrade", + "daysTrialRemaining": 62 + } + } + } + } +} + diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorGetExpand.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorGetExpand.json new file mode 100644 index 000000000000..9910c33da554 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorGetExpand.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "connectorName": "12345678-9012-3456-7890-111111111111", + "$expand": "collectionInfo" + }, + "responses": { + "200": { + "body": { + "kind": "aws", + "id": "/providers/Microsoft.CostManagement/cloudConnectors/12345678-9012-3456-7890-111111111111", + "name": "12345678-9012-3456-7890-111111111111", + "type": "Microsoft.CostManagement/cloudConnectors", + "properties": { + "displayName": "AWS-Consolidated-1", + "providerAccountId": "123456789012", + "credentialsKey": "arn:aws:iam::123456789012:role/AzureCostManagementRole", + "reportId": "HourlyWithResources", + "createdOn": "2018-05-15T13:25:48Z", + "modifiedOn": "2018-05-23T09:21:11Z", + "status": "active", + "defaultManagementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ", + "subscriptionId": "22222222-3333-4444-1111-777777777777", + "billingModel": "autoUpgrade", + "daysTrialRemaining": 62, + "collectionInfo": { + "lastChecked": "2018-06-15T03:21:08Z", + "sourceLastUpdated": "2018-06-12T16:41:28Z", + "lastUpdated": "2018-06-12T17:25:28Z", + "error": { + "errorCode": "FailedToAssumeRole", + "errorMessage": "Failed to assume role", + "errorInnerMessage": "Insufficient access to assume role arn:aws:iam::123456789012:role/AzureCostManagementRole", + "errorStartTime": "2018-06-12T21:41:03Z" + } + } + } + } + } + } +} + diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorList.json new file mode 100644 index 000000000000..fc078b4226fb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "aws", + "id": "/providers/Microsoft.CostManagement/cloudConnectors/12345678-9012-3456-7890-111111111111", + "name": "12345678-9012-3456-7890-111111111111", + "type": "Microsoft.CostManagement/cloudConnectors", + "properties": { + "displayName": "AWS-Consolidated-1", + "providerAccountId": "123456789012", + "credentialsKey": "arn:aws:iam::123456789012:role/AzureCostManagementRole", + "reportId": "HourlyWithResources", + "createdOn": "2018-05-15T13:25:48Z", + "modifiedOn": "2018-05-23T09:21:11Z", + "status": "active", + "defaultManagementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ", + "subscriptionId": "22222222-3333-4444-1111-777777777777", + "billingModel": "autoUpgrade", + "daysTrialRemaining": 62 + } + }, + { + "kind": "aws", + "id": "/providers/Microsoft.CostManagement/cloudConnectors/11111111-2222-3333-4444-555555555555", + "name": "11111111-2222-3333-4444-555555555555", + "type": "Microsoft.CostManagement/cloudConnectors", + "properties": { + "displayName": "AWS-Consolidated-2", + "providerAccountId": "100000000007", + "credentialsKey": "arn:aws:iam::100000000007:role/AzureCostManagementRole", + "reportId": "CURHourlyWithResources", + "createdOn": "2018-06-16T11:23:44Z", + "modifiedOn": "2018-06-21T17:33:28Z", + "status": "suspended", + "defaultManagementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ", + "subscriptionId": "22222222-3333-4444-1111-777777777777", + "billingModel": "premium" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorPatch.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorPatch.json new file mode 100644 index 000000000000..7b1194753c45 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorPatch.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "connectorName": "12345678-9012-3456-7890-111111111111", + "connector": { + "properties": { + "displayName": "AWS-Consolidated-3" + } + } + }, + "responses": { + "200": { + "body": { + "kind": "aws", + "id": "/providers/Microsoft.CostManagement/cloudConnectors/12345678-9012-3456-7890-111111111111", + "name": "12345678-9012-3456-7890-111111111111", + "type": "Microsoft.CostManagement/cloudConnectors", + "properties": { + "displayName": "AWS-Consolidated-3", + "credentialsKey": "arn:aws:iam::123456789012:role/AzureCostManagementRole", + "reportId": "HourlyWithResources", + "createdOn": "2018-05-15T13:25:48Z", + "modifiedOn": "2018-05-23T09:21:11Z", + "status": "active", + "defaultManagementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ", + "subscriptionId": "22222222-3333-4444-1111-777777777777", + "billingModel": "autoUpgrade", + "daysTrialRemaining": 62 + } + } + } + } +} + diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorPut.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorPut.json new file mode 100644 index 000000000000..29c4fd1a13a9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/CloudConnectorPut.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "connectorName": "12345678-9012-3456-7890-111111111111", + "connector": { + "properties": { + "displayName": "AWS-Consolidated-1", + "credentialsKey": "arn:aws:iam::123456789012:role/AzureCostManagementRole", + "credentialsSecret": "external-id", + "reportId": "HourlyWithResources", + "status": "active" + } + } + }, + "responses": { + "200": { + "body": { + "kind": "aws", + "id": "/providers/Microsoft.CostManagement/cloudConnectors/12345678-9012-3456-7890-111111111111", + "name": "12345678-9012-3456-7890-111111111111", + "type": "Microsoft.CostManagement/cloudConnectors", + "properties": { + "displayName": "AWS-Consolidated-1", + "credentialsKey": "arn:aws:iam::123456789012:role/AzureCostManagementRole", + "reportId": "HourlyWithResources", + "createdOn": "2018-05-15T13:25:48Z", + "modifiedOn": "2018-05-23T09:21:11Z", + "status": "active", + "subscriptionId": "22222222-3333-4444-1111-777777777777", + "billingModel": "autoUpgrade", + "daysTrialRemaining": 62 + } + } + }, + "201": { + "body": { + "kind": "aws", + "id": "/providers/Microsoft.CostManagement/cloudConnectors/12345678-9012-3456-7890-111111111111", + "name": "12345678-9012-3456-7890-111111111111", + "type": "Microsoft.CostManagement/cloudConnectors", + "properties": { + "displayName": "AWS-Consolidated-1", + "credentialsKey": "arn:aws:iam::123456789012:role/AzureCostManagementRole", + "reportId": "HourlyWithResources", + "createdOn": "2018-05-15T13:25:48Z", + "modifiedOn": "2018-05-23T09:21:11Z", + "status": "active", + "defaultManagementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ", + "subscriptionId": "22222222-3333-4444-1111-777777777777", + "billingModel": "autoUpgrade", + "daysTrialRemaining": 62 + } + } + } + } +} + diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsList.json new file mode 100644 index 000000000000..89b95546d1fc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100", + "departmentId": "123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.consumption/dimensions_ResourceType_2018-12-01_2018-12-31", + "name": "dimensions_ResourceType_2018-12-01_2018-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..c34403dc70b6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsListExpandAndTop.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.consumption/dimensions_ResourceType_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceType_2018-12-01_2018-12-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-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsListWithFilter.json new file mode 100644 index 000000000000..cae08c00c4b6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentDimensionsListWithFilter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.consumption/dimensions_ResourceId_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceId_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.Consumption/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-03-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentForecast.json new file mode 100644 index 000000000000..17f3f91e8830 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentForecast.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "departmentId": "123", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-10-01T00:00:00.000Z", + "to": "2018-12-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "SubscriptionName", + "operator": "In", + "values": [ + "Azure Dev Subscription", + "Azure Prod Subscription", + "Azure PPE Subscription" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "AccountName", + "operator": "In", + "values": [ + "Azure Account" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Forecast/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Forecast", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + 20181026, + "Actual", + "USD" + ], + [ + 20.41179241293923, + 20181027, + "Actual", + "USD" + ], + [ + 21.359416562625452, + 20181028, + "Actual", + "USD" + ], + [ + 22.545363672276512, + 20181029, + "Forecast", + "USD" + ], + [ + 23.41979241290323, + 20181030, + "Forecast", + "USD" + ], + [ + 24.359416562625452, + 20181031, + "Forecast", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentQuery.json new file mode 100644 index 000000000000..7c05492c89b8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentQuery.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "departmentId": "123", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-10-01T00:00:00.000Z", + "to": "2018-12-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "and": [ + { + "or":[ + { + "dimension": { + "name": "SubscriptionName", + "operator": "In", + "values": [ + "Azure Dev Subscription", + "Azure Prod Subscription", + "Azure PPE Subscription" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "AccountName", + "operator": "In", + "values": [ + "Azure Account" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + 20181031, + "USD" + ], + [ + 173.41979241290323, + 20181031, + "USD" + ], + [ + 20.359416562625452, + 20181031, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentQueryGrouping.json new file mode 100644 index 000000000000..78c9377d4d5e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/DepartmentQueryGrouping.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "departmentId": "123", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "AccountName" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "AccountName", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "Azure Dev Account", + "USD" + ], + [ + 173.41979241290323, + "Azure PPE Account", + "USD" + ], + [ + 20.359416562625452, + "Azure Prod Account", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsList.json new file mode 100644 index 000000000000..1689becf8479 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.consumption/dimensions_ResourceType_2018-12-01_2018-12-31", + "name": "dimensions_ResourceType_2018-12-01_2018-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..c6765a2fe044 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.consumption/dimensions_ResourceType_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceType_2018-12-01_2018-12-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-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..3114a3bc5633 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.consumption/dimensions_ResourceId_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceId_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.Consumption/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-03-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountForecast.json new file mode 100644 index 000000000000..fa4247f3a054 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountForecast.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "or":[ + { + "dimension": { + "name": "SubscriptionName", + "operator": "In", + "values": [ + "Azure Dev Subscription", + "Azure Prod Subscription", + "Azure PPE Subscription" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Forecast", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 168.545323467227622, + 20180826, + "Actual", + "USD" + ], + [ + 169.41979241290344, + 20180927, + "Actual", + "USD" + ], + [ + 170.359416562338452, + 20181028, + "Actual", + "USD" + ], + [ + 172.545363234276512, + 20180829, + "Forecast", + "USD" + ], + [ + 173.41979241290323, + 20180930, + "Forecast", + "USD" + ], + [ + 174.359416562625452, + 20181031, + "Forecast", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountQuery.json new file mode 100644 index 000000000000..8b737fabd400 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountQuery.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "or":[ + { + "dimension": { + "name": "SubscriptionName", + "operator": "In", + "values": [ + "Azure Dev Subscription", + "Azure Prod Subscription", + "Azure PPE Subscription" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + 20180831, + "USD" + ], + [ + 173.41979241290323, + 20180930, + "USD" + ], + [ + 20.359416562625452, + 20181031, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountQueryGrouping.json new file mode 100644 index 000000000000..65e6d86f817b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/EnrollmentAccountQueryGrouping.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "SubscriptionName" + } + ], + "sorting": [ + { + "name": "UsageDate" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "SubscriptionName", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "Azure Dev Subscription", + 20180831, + "USD" + ], + [ + 173.41979241290323, + "Azure PPE Subscription", + 20180930, + "USD" + ], + [ + 20.359416562625452, + "Azure Prod Subscription", + 20181031, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountExternalSubscriptionList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountExternalSubscriptionList.json new file mode 100644 index 000000000000..c937d61bed93 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountExternalSubscriptionList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "externalBillingAccountName": "aws-123456789012" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/aws-654321654321", + "name": "aws-654321654321", + "type": "Microsoft.CostManagement/externalSubscriptions", + "kind": "aws", + "properties": { + "displayName": "MyUsageAccount1", + "externalBillingAccountId": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-123456789012", + "managementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountGet.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountGet.json new file mode 100644 index 000000000000..bcd1c2b75eac --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "externalBillingAccountName": "aws-123456789012" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-123456789012", + "name": "aws-123456789012", + "type": "Microsoft.CostManagement/externalBillingAccounts", + "kind": "aws", + "properties": { + "displayName": "Contoso Consolidated", + "connectorId": "/providers/Microsoft.CostManagement/cloudConnectors/12345678-9012-3456-7890-111111111111" + } + } + } + } +} + diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountList.json new file mode 100644 index 000000000000..f9570937df4b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalBillingAccountList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-123456789012", + "name": "aws-123456789012", + "type": "Microsoft.CostManagement/externalBillingAccounts", + "kind": "aws", + "properties": { + "displayName": "Contoso Consolidated", + "connectorId": "/providers/Microsoft.CostManagement/cloudConnectors/12345678-9012-3456-7890-111111111111" + } + }, + { + "id": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-112233445566", + "name": "aws-112233445566", + "type": "Microsoft.CostManagement/externalBillingAccounts", + "kind": "aws", + "properties": { + "displayName": "Contoso Consolidated2", + "connectorId": "/providers/Microsoft.CostManagement/cloudConnectors/11111111-2222-3333-4444-555555555555" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalSubscriptionGet.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalSubscriptionGet.json new file mode 100644 index 000000000000..04ce17b57bd5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalSubscriptionGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "externalSubscriptionName": "aws-654321654321" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/aws-654321654321", + "name": "aws-654321654321", + "type": "Microsoft.CostManagement/externalSubscriptions", + "kind": "aws", + "properties": { + "displayName": "MyUsageAccount1", + "externalBillingAccountId": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-123456789012", + "managementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ" + } + } + } + } +} + diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalSubscriptionList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalSubscriptionList.json new file mode 100644 index 000000000000..885cedfc4bf8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ExternalSubscriptionList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/aws-654321654321", + "name": "aws-654321654321", + "type": "Microsoft.CostManagement/externalSubscriptions", + "kind": "aws", + "properties": { + "displayName": "MyUsageAccount1", + "externalBillingAccountId": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-123456789012", + "managementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ" + } + }, + { + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/aws-110011001100", + "name": "aws-110011001100", + "type": "Microsoft.CostManagement/externalSubscriptions", + "kind": "aws", + "properties": { + "displayName": "MyUsageAccount2", + "externalBillingAccountId": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-112233445566", + "managementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsList.json new file mode 100644 index 000000000000..3cd7bdbe6ab5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.consumption/dimensions_ResourceType_2018-12-01_2018-12-31", + "name": "dimensions_ResourceType_2018-12-01_2018-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..7b9960077fde --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.consumption/dimensions_ResourceType_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceType_2018-12-01_2018-12-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-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsListWithFilter.json new file mode 100644 index 000000000000..83a8ac2f5e94 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupDimensionsListWithFilter.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.consumption/dimensions_ResourceId_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceId_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.Consumption/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2018-12-31-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupExternalSubscriptionList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupExternalSubscriptionList.json new file mode 100644 index 000000000000..7460c8c280b3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupExternalSubscriptionList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "XYZ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.CostManagement/externalSubscription/aws-654321654321", + "name": "aws-654321654321", + "type": "Microsoft.CostManagement/externalSubscription", + "properties": { + "displayName": "MyUsageAccount1", + "externalBillingAccountId": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-123456789012", + "managementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ" + } + }, + { + "id": "/providers/Microsoft.CostManagement/externalSubscription/aws-110011001100", + "name": "aws-110011001100", + "type": "Microsoft.CostManagement/externalSubscription", + "properties": { + "displayName": "MyUsageAccount2", + "externalBillingAccountId": "/providers/Microsoft.CostManagement/externalBillingAccounts/aws-112233445566", + "managementGroupId" : "/providers/Microsoft.Management/managementGroups/XYZ" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupExternalSubscriptionPut.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupExternalSubscriptionPut.json new file mode 100644 index 000000000000..3c1613933177 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupExternalSubscriptionPut.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "XYZ", + "externalSubscriptionName": "aws-654321654321" + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupForecast.json new file mode 100644 index 000000000000..4cd999c72afe --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupForecast.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "MyMgId", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-11-01T00:00:00.000Z", + "to": "2019-01-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "or":[ + { + "dimension": { + "name": "SubscriptionName", + "operator": "In", + "values": [ + "Azure Dev", + "Azure Prod", + "Azure PPE" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Forecast/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Forecast", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Forecast?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.045363672276512, + 20190126, + "Actual", + "USD" + ], + [ + 19.41979241290323, + 20190127, + "Actual", + "USD" + ], + [ + 20.359416562625452, + 20190128, + "Actual", + "USD" + ], + [ + 19.045363672276512, + 20190129, + "Forecast", + "USD" + ], + [ + 19.41979241290323, + 20190130, + "Forecast", + "USD" + ], + [ + 20.359416562625452, + 20190131, + "Forecast", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupGetEntities.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupGetEntities.json new file mode 100644 index 000000000000..833ff97e59f2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupGetEntities.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "XYZ" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Management/managementGroups/XYZ", + "type": "/providers/Microsoft.Management/managementGroups", + "name": "XYZ", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "XYZ Department", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/Engineering" + }, + "permissions": "noaccess", + "inheritedPermissions": "view", + "numberOfDescendants": 0, + "numberOfChildren": 0, + "numberOfChildGroups": 0, + "parentDisplayNameChain": [ + "20000000-0000-0000-0000-000000000000", + "Engineering" + ], + "parentNameChain": [ + "20000000-0000-0000-0000-000000000000", + "Engineering" + ] + } + }, + { + "id": "/subscriptions/88888888-3333-6666-1111-444444444444", + "type": "/subscriptions", + "name": "88888888-3333-6666-1111-444444444444", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "XYZ Subscription", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/XYZ" + }, + "permissions": "noaccess", + "inheritedPermissions": "view", + "numberOfDescendants": 0, + "numberOfChildren": 0, + "numberOfChildGroups": 0, + "parentDisplayNameChain": [ + "20000000-0000-0000-0000-000000000000", + "Engineering", + "XYZ Department" + ], + "parentNameChain": [ + "20000000-0000-0000-0000-000000000000", + "Engineering", + "XYZ" + ] + } + }, + { + "id": "/providers/Microsoft.CostManagement/externalSubscriptions/aws-654321654321", + "type": "Microsoft.CostManagement/externalSubscriptions", + "name": "aws-654321654321", + "kind": "aws", + "properties": { + "tenantId": "20000000-0000-0000-0000-000000000000", + "displayName": "XYZ UsageAccount", + "parent": { + "id": "/providers/Microsoft.Management/managementGroups/XYZ" + }, + "permissions": "noaccess", + "inheritedPermissions": "view", + "numberOfDescendants": 0, + "numberOfChildren": 0, + "numberOfChildGroups": 0, + "parentDisplayNameChain": [ + "20000000-0000-0000-0000-000000000000", + "Engineering", + "XYZ Department" + ], + "parentNameChain": [ + "20000000-0000-0000-0000-000000000000", + "Engineering", + "XYZ" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupQuery.json new file mode 100644 index 000000000000..426805646f4f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupQuery.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "MyMgId", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-11-01T00:00:00.000Z", + "to": "2019-01-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "or":[ + { + "dimension": { + "name": "SubscriptionName", + "operator": "In", + "values": [ + "Azure Dev", + "Azure Prod", + "Azure PPE" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + 20181131, + "USD" + ], + [ + 173.41979241290323, + 20181231, + "USD" + ], + [ + 20.359416562625452, + 20190131, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupQueryGrouping.json new file mode 100644 index 000000000000..f8b13c585079 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ManagementGroupQueryGrouping.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "managementGroupId": "MyMgId", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "SubscriptionName" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2019-03-01-preview&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "SubscriptionName", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "Trial Subscription", + "USD" + ], + [ + 173.41979241290323, + "DEV Subscription", + "USD" + ], + [ + 20.35941656262545, + "Cost Management Subscrioption", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupDimensionsList.json new file mode 100644 index 000000000000..34aee5fa0cf0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupDimensionsList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "system.orlando", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/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", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.consumption/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/authprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/systemevents", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/armadminprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/publicsystemportal" + ], + "total": 27, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupForecast.json new file mode 100644 index 000000000000..b214a77885fd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupForecast.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", + "resourceGroupName": "ScreenSharingTest-peer", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "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/Forecast/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Forecast", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.10333307059661, + 20180417, + "Actual", + "USD" + ], + [ + 20.10333307059661, + 20180418, + "Actual", + "USD" + ], + [ + 21.10333307059661, + 20180419, + "Forecast", + "USD" + ], + [ + 22.10333307059661, + 20180420, + "Forecast", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupQuery.json new file mode 100644 index 000000000000..14eaef3e8f4f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/ResourceGroupQuery.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", + "resourceGroupName": "ScreenSharingTest-peer", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "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": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180417, + "USD" + ], + [ + 20.10333307059661, + 20180418, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionDimensionsList.json new file mode 100644 index 000000000000..ef1d011d3a1c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionDimensionsList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$top": 5, + "$expand": "properties/data" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceGroup_2018-12-01_2018-12-31_5", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "dcrg", + "rg", + "offlinegalleryrg", + "system.orlando.adminkeyvault", + "system.orlando.keyvault" + ], + "total": 68, + "category": "ResourceGroup", + "usageStart": "2018-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/dimensions_ResourceType_2018-12-01_2018-12-31_5", + "name": "dimensions_ResourceType_2018-12-01_2018-12-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-12-01T00:00:00-07:00", + "usageEnd": "2018-12-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionForecast.json new file mode 100644 index 000000000000..f12e2175568d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionForecast.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-10-01T00:00:00.000Z", + "to": "2018-12-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Forecast/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Forecast", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 214.68795741935486, + 20181222, + "Actual", + "USD" + ], + [ + 215.68795741935486, + 20181223, + "Actual", + "USD" + ], + [ + 216.68795741935486, + 20181224, + "Actual", + "USD" + ], + [ + 217.68795741935486, + 20181225, + "Actual", + "USD" + ], + [ + 218.68795741935486, + 20181226, + "Actual", + "USD" + ], + [ + 219.143849143581657052, + 20181227, + "Actual", + "USD" + ], + [ + 220.143849143588766052, + 20181228, + "Forecast", + "USD" + ], + [ + 221.143433143588766052, + 20181229, + "Forecast", + "USD" + ], + [ + 222.143433555588766052, + 20181230, + "Forecast", + "USD" + ], + [ + 223.143433555588743252, + 20181231, + "Forecast", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionQuery.json new file mode 100644 index 000000000000..5bfac70c4632 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2019-03-01-preview/examples/SubscriptionQuery.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2019-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-10-01T00:00:00.000Z", + "to": "2018-12-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20181017, + "USD" + ], + [ + 218.68795741935486, + 20181018, + "USD" + ], + [ + 0.14384913581657052, + 20181019, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json new file mode 100644 index 000000000000..33b430e3bce9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/costmanagement.json @@ -0,0 +1,1414 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ListBySubscription", + "description": "Lists the dimensions by the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionDimensionsList": { + "$ref": "./examples/SubscriptionDimensionsList.json" + }, + "ResourceGroupDimensionsList": { + "$ref": "./examples/ResourceGroupDimensionsList.json" + }, + "ManagementGroupDimensionsList": { + "$ref": "./examples/ManagementGroupDimensionsList.json" + }, + "ManagementGroupDimensionsListExpandAndTop": { + "$ref": "./examples/ManagementGroupDimensionsListExpandAndTop.json" + }, + "ManagementGroupDimensionsListWithFilter": { + "$ref": "./examples/ManagementGroupDimensionsListWithFilter.json" + }, + "DepartmentDimensionsList": { + "$ref": "./examples/DepartmentDimensionsList.json" + }, + "DepartmentDimensionsListExpandAndTop": { + "$ref": "./examples/DepartmentDimensionsListExpandAndTop.json" + }, + "DepartmentDimensionsListWithFilter": { + "$ref": "./examples/DepartmentDimensionsListWithFilter.json" + }, + "EnrollmentAccountDimensionsList": { + "$ref": "./examples/EnrollmentAccountDimensionsList.json" + }, + "EnrollmentAccountDimensionsListExpandAndTop": { + "$ref": "./examples/EnrollmentAccountDimensionsListExpandAndTop.json" + }, + "EnrollmentAccountDimensionsListWithFilter": { + "$ref": "./examples/EnrollmentAccountDimensionsListWithFilter.json" + }, + "BillingAccountDimensionsList": { + "$ref": "./examples/BillingAccountDimensionsList.json" + }, + "BillingAccountDimensionsListExpandAndTop": { + "$ref": "./examples/BillingAccountDimensionsListExpandAndTop.json" + }, + "BillingAccountDimensionsListWithFilter": { + "$ref": "./examples/BillingAccountDimensionsListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeDimensionParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "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 + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_UsageByScope", + "description": "Query the usage data for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionQuery": { + "$ref": "./examples/SubscriptionQuery.json" + }, + "ResourceGroupQuery": { + "$ref": "./examples/ResourceGroupQuery.json" + }, + "BillingAccountQuery": { + "$ref": "./examples/BillingAccountQuery.json" + }, + "BillingAccountQueryGrouping": { + "$ref": "./examples/BillingAccountQueryGrouping.json" + }, + "EnrollmentAccountQuery": { + "$ref": "./examples/EnrollmentAccountQuery.json" + }, + "EnrollmentAccountQueryGrouping": { + "$ref": "./examples/EnrollmentAccountQueryGrouping.json" + }, + "DepartmentQuery": { + "$ref": "./examples/DepartmentQuery.json" + }, + "DepartmentQueryGrouping": { + "$ref": "./examples/DepartmentQueryGrouping.json" + }, + "ManagementGroupQuery": { + "$ref": "./examples/ManagementGroupQuery.json" + }, + "ManagementGroupQueryGrouping": { + "$ref": "./examples/ManagementGroupQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Query Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_List", + "description": "Lists all exports at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionExportList": { + "$ref": "./examples/ExportList.json" + }, + "ResourceGroupExportList": { + "$ref": "./examples/ExportList.json" + }, + "BillingAccountExportList": { + "$ref": "./examples/ExportListByBillingAccount.json" + }, + "DepartmentExportList": { + "$ref": "./examples/ExportListByDepartment.json" + }, + "EnrollmentAccountExportList": { + "$ref": "./examples/ExportListByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Get", + "description": "Gets the export for the defined scope by export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionExport": { + "$ref": "./examples/Export.json" + }, + "BillingAccountExport": { + "$ref": "./examples/ExportByBillingAccount.json" + }, + "DepartmentExport": { + "$ref": "./examples/ExportByDepartment.json" + }, + "EnrollmentAccountExport": { + "$ref": "./examples/ExportByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Exports" + ], + "operationId": "Exports_CreateOrUpdate", + "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdate.json" + }, + "ResourceGroupCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdate.json" + }, + "BillingAccountCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" + }, + "DepartmentCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" + }, + "EnrollmentAccountCreateOrUpdateExport": { + "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Export" + }, + "description": "Parameters supplied to the CreateOrUpdate Export operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Delete", + "description": "The operation to delete a export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionDeleteExport": { + "$ref": "./examples/ExportDelete.json" + }, + "ResourceGroupDeleteExport": { + "$ref": "./examples/ExportDelete.json" + }, + "BillingAccountDeleteExport": { + "$ref": "./examples/ExportDeleteByBillingAccount.json" + }, + "EnrollmentAccountDeleteExport": { + "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" + }, + "DepartmentDeleteExport": { + "$ref": "./examples/ExportDeleteByDepartment.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { + "post": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Execute", + "description": "The operation to execute a export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionExecuteExport": { + "$ref": "./examples/ExportExecution.json" + }, + "ResourceGroupExecuteExport": { + "$ref": "./examples/ExportExecution.json" + }, + "BillingAccountExecuteExport": { + "$ref": "./examples/ExportExecutionByBillingAccount.json" + }, + "DepartmentExecuteExport": { + "$ref": "./examples/ExportExecutionByDepartment.json" + }, + "EnrollmentAccountExecuteExport": { + "$ref": "./examples/ExportExecutionByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_GetExecutionHistory", + "description": "Gets the execution history of a export for the defined scope by export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionList.json" + }, + "ResourceGroupExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionList.json" + }, + "BillingAccountExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListByBillingAccount.json" + }, + "DepartmentExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListByDepartment.json" + }, + "EnrollmentAccountExecutionHistoryExport": { + "$ref": "./examples/ExportExecutionListByEnrollmentAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportExecutionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available cost 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" + } + } + } + }, + "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 + }, + "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": { + "description": { + "type": "string" + }, + "filterEnabled": { + "type": "boolean" + }, + "groupingEnabled": { + "type": "boolean" + }, + "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" + } + } + }, + "OperationListResult": { + "description": "Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of cost management operations supported by the Microsoft.CostManagement resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Cost management 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.CostManagement.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: Dimensions, Query.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "QueryDefinition": { + "description": "The definition of a query.", + "properties": { + "type": { + "description": "The type of the query.", + "type": "string", + "enum": [ + "Usage" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "WeekToDate", + "MonthToDate", + "YearToDate", + "TheLastWeek", + "TheLastMonth", + "TheLastYear", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the query.", + "$ref": "#/definitions/QueryTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this query.", + "$ref": "#/definitions/QueryDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "QueryTimePeriod": { + "description": "The start and end date for pulling data for the query.", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "QueryDataset": { + "description": "The definition of data present in the query.", + "properties": { + "granularity": { + "description": "The granularity of rows in the query.", + "type": "string", + "enum": [ + "Daily", + "Hourly" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/QueryDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/QueryAggregation" + }, + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryGrouping" + }, + "maxItems": 2 + }, + "sorting": { + "type": "array", + "description": "Array of sorting by columns in query.", + "items": { + "$ref": "#/definitions/QuerySortingConfiguration" + } + }, + "filter": { + "type": "object", + "description": "Has filter expression to use in the query.", + "$ref": "#/definitions/QueryFilter" + } + } + }, + "QuerySortingConfiguration": { + "description": "The configuration for sorting in the query.", + "type": "object", + "properties": { + "querySortingDirection": { + "description": "The sorting direction", + "type": "string", + "enum": [ + "Ascending", + "Descending" + ], + "x-ms-enum": { + "name": "SortDirection", + "modelAsString": true + } + }, + "name": { + "description": "The name of the column to use in sorting.", + "type": "string" + } + } + }, + "QueryDatasetConfiguration": { + "description": "The configuration of dataset in the query.", + "properties": { + "columns": { + "description": "Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "QueryAggregation": { + "description": "The aggregation expression to be used in the query.", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "QueryGrouping": { + "description": "The group by expression to be used in the query.", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/QueryColumnType" + }, + "name": { + "description": "The name of the column to group.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "QueryFilter": { + "description": "The filter expression to be used in the export.", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "minItems": 2 + }, + "not": { + "description": "The logical \"NOT\" expression.", + "$ref": "#/definitions/QueryFilter" + }, + "dimension": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/QueryComparisonExpression" + }, + "tag": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/QueryComparisonExpression" + } + } + }, + "QueryColumnType": { + "description": "The type of the column in the export.", + "type": "string", + "enum": [ + "Tag", + "Dimension" + ], + "x-ms-enum": { + "name": "QueryColumnType", + "modelAsString": true + } + }, + "QueryComparisonExpression": { + "description": "The comparison expression to be used in the query.", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ExportListResult": { + "description": "Result of listing exports. It contains a list of available exports in the scope provided.", + "properties": { + "value": { + "description": "The list of exports.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Export" + } + } + } + }, + "Export": { + "description": "A export resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportProperties", + "title": "Export properties" + } + } + }, + "ExportProperties": { + "description": "The properties of the export.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonExportProperties" + } + ], + "properties": { + "schedule": { + "description": "Has schedule information for the export.", + "$ref": "#/definitions/ExportSchedule" + } + } + }, + "CommonExportProperties": { + "description": "The common properties of the export.", + "properties": { + "format": { + "description": "The format of the export being delivered.", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FormatType", + "modelAsString": true + } + }, + "deliveryInfo": { + "description": "Has delivery information for the export.", + "$ref": "#/definitions/ExportDeliveryInfo" + }, + "definition": { + "description": "Has definition for the export.", + "$ref": "#/definitions/QueryDefinition" + } + }, + "required": [ + "deliveryInfo", + "definition" + ] + }, + "ExportSchedule": { + "description": "The schedule associated with a export.", + "properties": { + "status": { + "description": "The status of the schedule. Whether active or not. If inactive, the export'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/ExportRecurrencePeriod" + } + }, + "required": [ + "recurrence" + ] + }, + "ExportDeliveryInfo": { + "description": "The delivery information associated with a export.", + "properties": { + "destination": { + "description": "Has destination for the export being delivered.", + "$ref": "#/definitions/ExportDeliveryDestination" + } + }, + "required": [ + "destination" + ] + }, + "ExportRecurrencePeriod": { + "description": "The start and end date for recurrence schedule.", + "properties": { + "from": { + "description": "The start date of recurrence.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date of recurrence.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from" + ] + }, + "ExportDeliveryDestination": { + "description": "The destination information for the delivery of the export.", + "properties": { + "resourceId": { + "description": "The resource id of the storage account where exports will be delivered.", + "type": "string" + }, + "container": { + "description": "The name of the container where exports will be uploaded.", + "type": "string" + }, + "rootFolderPath": { + "description": "The name of the directory where exports will be uploaded.", + "type": "string" + } + }, + "required": [ + "resourceId", + "container" + ] + }, + "ExportExecutionListResult": { + "description": "Result of listing exports execution history of a export by name", + "properties": { + "value": { + "description": "The list of export executions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExportExecution" + } + } + } + }, + "ExportExecution": { + "description": "A export execution.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportExecutionProperties", + "title": "Export execution properties" + } + } + }, + "ExportExecutionProperties": { + "description": "The properties of the export execution.", + "properties": { + "executionType": { + "description": "The type of the export execution.", + "type": "string", + "enum": [ + "OnDemand", + "Scheduled" + ], + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true + } + }, + "status": { + "description": "The status of the export execution.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "Completed", + "Failed", + "Timeout", + "NewDataNotAvailable", + "DataNotAvailable" + ], + "x-ms-enum": { + "name": "ExecutionStatus", + "modelAsString": true + } + }, + "submittedBy": { + "description": "The identifier for the entity that executed the export. For OnDemand executions, it is the email id. For Scheduled executions, it is the constant value - System.", + "type": "string" + }, + "submittedTime": { + "description": "The time when export was queued to be executed.", + "type": "string", + "format": "date-time" + }, + "processingStartTime": { + "description": "The time when export was picked up to be executed.", + "type": "string", + "format": "date-time" + }, + "processingEndTime": { + "description": "The time when export execution finished.", + "type": "string", + "format": "date-time" + }, + "fileName": { + "description": "The name of the file export got written to.", + "type": "string" + }, + "runSettings": { + "$ref": "#/definitions/CommonExportProperties" + } + } + } + }, + "parameters": { + "scopeDimensionParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with dimension operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope..", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeQueryParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with query and export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope..", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "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" + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "description": "ManagementGroup ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "Enrollment Account ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "exportNameParameter": { + "name": "exportName", + "in": "path", + "description": "Export Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsList.json new file mode 100644 index 000000000000..b9f5918e4fa3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..2758e49d8cd3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..90bc0b843233 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountDimensionsListWithFilter.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/ccmapi/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-01-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountQuery.json new file mode 100644 index 000000000000..92b50ea0cec7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountQuery.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "70664866", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "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" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountQueryGrouping.json new file mode 100644 index 000000000000..0745bf34512f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/BillingAccountQueryGrouping.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "70664866", + "parameters":{ + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "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": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsList.json new file mode 100644 index 000000000000..2bbda0e6a272 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "departmentId": "123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..bfd2ad5a29f3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsListExpandAndTop.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsListWithFilter.json new file mode 100644 index 000000000000..20648e479031 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentDimensionsListWithFilter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-01-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentQuery.json new file mode 100644 index 000000000000..8c18343ea77e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentQuery.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "70664866", + "departmentId": "123", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "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/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2019-01-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentQueryGrouping.json new file mode 100644 index 000000000000..0598d0eb209f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/DepartmentQueryGrouping.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "70664866", + "departmentId": "123", + "parameters":{ + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2019-01-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsList.json new file mode 100644 index 000000000000..f8f029779d6b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "enrollmentAccountId": "456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..9f05831c65ef --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..d45b42ec7ab4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-01-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountQuery.json new file mode 100644 index 000000000000..0971bf9fe43c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountQuery.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "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/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2019-01-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountQueryGrouping.json new file mode 100644 index 000000000000..212d475ef1f8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/EnrollmentAccountQueryGrouping.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "parameters":{ + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ], + "sorting": [ + { + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2019-01-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/Export.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/Export.json new file mode 100644 index 000000000000..f9137eabaf86 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/Export.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/{subscription-id}/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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/2019-01-01/examples/ExportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportByBillingAccount.json new file mode 100644 index 000000000000..60aeb7f2ad42 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportByBillingAccount.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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/2019-01-01/examples/ExportByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportByDepartment.json new file mode 100644 index 000000000000..933958f10d57 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportByDepartment.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "departmentId": "1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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/2019-01-01/examples/ExportByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportByEnrollmentAccount.json new file mode 100644 index 000000000000..cde78ab1a1c7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportByEnrollmentAccount.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "enrollmentAccountId": "1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/enrollmentAccounts/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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/2019-01-01/examples/ExportCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportCreateOrUpdate.json new file mode 100644 index 000000000000..3fb355728a8a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportCreateOrUpdate.json @@ -0,0 +1,287 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "exportName": "TestExport", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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/2019-01-01/examples/ExportCreateOrUpdateByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportCreateOrUpdateByBillingAccount.json new file mode 100644 index 000000000000..4ed4e59be795 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportCreateOrUpdateByBillingAccount.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "123456", + "exportName": "TestExport", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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/2019-01-01/examples/ExportCreateOrUpdateByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportCreateOrUpdateByDepartment.json new file mode 100644 index 000000000000..7607c3b45024 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportCreateOrUpdateByDepartment.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "departmentId": "1234", + "exportName": "TestExport", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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/2019-01-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json new file mode 100644 index 000000000000..cc2743d35598 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "enrollmentAccountId": "1234", + "exportName": "TestExport", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/12/enrollmentAccounts/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/12/enrollmentAccounts/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "Dimension", + "name": "SubscriptionName" + }, + { + "type": "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/2019-01-01/examples/ExportDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDelete.json new file mode 100644 index 000000000000..5f684882bf31 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByBillingAccount.json new file mode 100644 index 000000000000..cf6af7b140b6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByDepartment.json new file mode 100644 index 000000000000..7a5af5221c75 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByDepartment.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "departmentId": "1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByEnrollmentAccount.json new file mode 100644 index 000000000000..e6eef4d34b5a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportDeleteByEnrollmentAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "enrollmentAccountId": "1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecution.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecution.json new file mode 100644 index 000000000000..916f0ddc6da2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecution.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + } + } + } \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByBillingAccount.json new file mode 100644 index 000000000000..b9aff1fd8d4b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + } + } + } \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByDepartment.json new file mode 100644 index 000000000000..249ed27714f1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByDepartment.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "departmentId": "1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + } + } + } \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByEnrollmentAccount.json new file mode 100644 index 000000000000..510971f17922 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionByEnrollmentAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "enrollmentAccountId": "1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + } + } + } \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionList.json new file mode 100644 index 000000000000..9d17279a2113 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionList.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/{subscription-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "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": [ + { + "type": "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.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "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": [ + { + "type": "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" + ] + } + } + ] + } + } + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByBillingAccount.json new file mode 100644 index 000000000000..4e0ee014c511 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByBillingAccount.json @@ -0,0 +1,197 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "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": [ + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "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": [ + { + "type": "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" + ] + } + } + ] + } + } + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByDepartment.json new file mode 100644 index 000000000000..ccc085d712c5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByDepartment.json @@ -0,0 +1,197 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "departmentId": "1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "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": [ + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "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": [ + { + "type": "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" + ] + } + } + ] + } + } + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByEnrollmentAccount.json new file mode 100644 index 000000000000..023a74033716 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportExecutionListByEnrollmentAccount.json @@ -0,0 +1,197 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "enrollmentAccountId": "1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/enrollmentAccounts/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "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": [ + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/12/enrollmentAccounts/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "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": [ + { + "type": "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" + ] + } + } + ] + } + } + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportList.json new file mode 100644 index 000000000000..f481a6eb5595 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportList.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/{subscription-id}/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "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": [ + { + "type": "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.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "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/2019-01-01/examples/ExportListByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportListByBillingAccount.json new file mode 100644 index 000000000000..b957cc281abe --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportListByBillingAccount.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "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": [ + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "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/2019-01-01/examples/ExportListByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportListByDepartment.json new file mode 100644 index 000000000000..45eee8246431 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportListByDepartment.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "departmentId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "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": [ + { + "type": "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": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "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/2019-01-01/examples/ExportListByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportListByEnrollmentAccount.json new file mode 100644 index 000000000000..f1f922a1a67a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ExportListByEnrollmentAccount.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "departmentId": "1234" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/departments/{department-Id}/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition":{ + "type": "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": [ + { + "type": "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": "providers/Microsoft.Billing/departments/{department-Id}/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "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": "exports", + "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": [ + { + "type": "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/2019-01-01/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupDimensionsList.json new file mode 100644 index 000000000000..d9003efbed2b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupDimensionsList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..f8c7b72df3ef --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupDimensionsListWithFilter.json new file mode 100644 index 000000000000..86ea49c3e36f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupDimensionsListWithFilter.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-01-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupQuery.json new file mode 100644 index 000000000000..a1841f1dac58 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupQuery.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "MyMgId", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "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.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupQueryGrouping.json new file mode 100644 index 000000000000..b0363055b1a3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ManagementGroupQueryGrouping.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "managementGroupId": "MyMgId", + "parameters":{ + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ], + "sorting": [ + { + "name": "ResourceGroup", + "direction": "Descending" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupDimensionsList.json new file mode 100644 index 000000000000..dc0e9e8cf879 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupDimensionsList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "system.orlando", + "$expand": "properties/data", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts" + ], + "total": 1, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/authprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/systemevents", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/armadminprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/publicsystemportal" + ], + "total": 27, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupQuery.json new file mode 100644 index 000000000000..28f48b60520e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupQuery.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", + "resourceGroupName": "ScreenSharingTest-peer", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "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" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "ScreenSharingTest-peer", + 20180418, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupQueryGrouping.json new file mode 100644 index 000000000000..3f6e8959173b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/ResourceGroupQueryGrouping.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "parameters":{ + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceType" + } + ], + "sorting": [ + { + "name": "ResourceType", + "direction": "Descending" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceType", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "Microsoft.SqlServer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "Microsoft.Compute", + 20180418, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionDimensionsList.json new file mode 100644 index 000000000000..d02d49b3c0e6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionDimensionsList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$top": 5, + "$expand": "properties/data" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "dcrg", + "rg", + "offlinegalleryrg", + "system.orlando.adminkeyvault", + "system.orlando.keyvault" + ], + "total": 68, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts", + "microsoft.web.admin/role", + "microsoft.sql/servers", + "microsoft.compute/virtualmachines" + ], + "total": 4, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionQuery.json new file mode 100644 index 000000000000..5486e1b0562a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionQuery.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters":{ + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "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" + ] + } + } + ] + }, + "sorting": [ + { + "name": "UsageDate", + "sortingDirection": "Ascending" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180331, + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod", + 20180331, + "USD" + ], + [ + 0.14384913581657052, + "ssbciotelement01", + 20180401, + "USD" + ], + [ + 0.009865586851323632, + "ict_stratandplan_goldsprova_prod", + 20180429, + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionQueryGrouping.json new file mode 100644 index 000000000000..944ece81a2cc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-01-01/examples/SubscriptionQueryGrouping.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters":{ + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ], + "sorting": [ + { + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.009865586851323632, + "Ict_StratAndPlan_GoldSprova_Prod_0", + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod_1", + "USD" + ], + [ + 2.10333307059661, + "ScreenSharingTest-peer1", + "USD" + ], + [ + 0.14384913581657052, + "Ssbciotelement01", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/readme.go.md b/specification/cost-management/resource-manager/readme.go.md index 59ea8adf67c9..5402662fe5fe 100644 --- a/specification/cost-management/resource-manager/readme.go.md +++ b/specification/cost-management/resource-manager/readme.go.md @@ -14,6 +14,7 @@ go: batch: - tag: package-2018-05 - tag: package-2018-08-preview + - tag: package-2019-01 ``` ### Tag: package-2018-05 and go @@ -31,3 +32,11 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-01-01/$(namespace) +``` diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 2574976be824..9be7e6389925 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -5,7 +5,9 @@ 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` @@ -13,20 +15,39 @@ To build the SDK for Cost Management, simply [Install AutoRest](https://aka.ms/a 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-2019-01 azure-validator: true ``` --- + +### Tag: package-2019-01 + +These settings apply only when `--tag=package-2019-01` is specified on the command line. + +```yaml $(tag) == 'package-2019-01' +input-file: + - Microsoft.CostManagement/stable/2019-01-01/costmanagement.json +``` +### Tag: package-preview-2019-03 + +These settings apply only when `--tag=package-preview-2019-03` is specified on the command line. + +```yaml $(tag) == 'package-preview-2019-03' +input-file: + - Microsoft.CostManagement/preview/2019-03-01-preview/costmanagement.json +``` ### Tag: package-2018-05 These settings apply only when `--tag=package-2018-05` is specified on the command line. @@ -37,12 +58,17 @@ input-file: ``` ## Suppression + ``` yaml directive: - suppress: R2059 from: costmanagement.json where: $.paths reason: We are extending Microsoft.Billing RP in some scenarios + - suppress: R3023 + from: costmanagement.json + where: $.paths + reason: operations API for Microsoft.Billing are defined in Microsoft.Billing ``` ### Tag: package-2018-08-preview @@ -54,7 +80,6 @@ input-file: - Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json ``` - ### Tag: package-2018-12-preview These settings apply only when `--tag=package-2018-12-preview` is specified on the command line. @@ -64,8 +89,17 @@ input-file: - Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json ``` +### Tag: package-2019-01 + +These settings apply only when `--tag=package-2019-01` is specified on the command line. + +``` yaml $(tag) == 'package-2019-01' +input-file: +- Microsoft.CostManagement/stable/2019-01-01/costmanagement.json +``` --- + # Code Generation ## Swagger to SDK @@ -114,11 +148,13 @@ python: 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 @@ -149,6 +185,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-costmanagement batch: - tag: package-2018-05 - tag: package-2018-08-preview + - tag: package-2019-01 ``` ### Tag: package-2018-05 and java @@ -188,4 +225,17 @@ java: output-folder: $(azure-libraries-for-java-folder)/costmanagement/resource-manager/v2018_12_01_preview regenerate-manager: true generate-interface: true -``` \ No newline at end of file +``` + +### Tag: package-2019-01 and java + +These settings apply only when `--tag=package-2019-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2019-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.costmanagement.v2019_01_01 + output-folder: $(azure-libraries-for-java-folder)/costmanagement/resource-manager/v2019_01_01 +regenerate-manager: true +generate-interface: true +``` 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 856bfc7a6ce7..fbd268ade591 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 @@ -2022,24 +2022,20 @@ "$ref": "#/definitions/SSISPackageLocation" }, "runtime": { - "description": "Specifies the runtime to execute SSIS package.", - "type": "string", - "enum": [ - "x64", - "x86" - ], - "x-ms-enum": { - "name": "SSISExecutionRuntime", - "modelAsString": true - } + "description": "Specifies the runtime to execute SSIS package. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", + "type": "object" }, "loggingLevel": { - "description": "The logging level of SSIS package execution.", - "type": "string" + "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", + "type": "object" }, "environmentPath": { - "description": "The environment path to execute the SSIS package.", - "type": "string" + "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", + "type": "object" + }, + "executionCredential": { + "description": "The package execution credential.", + "$ref": "#/definitions/SSISExecutionCredential" }, "connectVia": { "description": "The integration runtime reference.", @@ -2091,8 +2087,8 @@ "type" : "object", "properties": { "packagePath": { - "description": "The SSIS package path.", - "type": "string" + "description": "The SSIS package path. Type: string (or Expression with resultType string).", + "type": "object" } }, "required": [ @@ -2136,6 +2132,29 @@ "value" ] }, + "SSISExecutionCredential": { + "description": "SSIS package execution credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecureString", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, "CustomActivity": { "description": "Custom activity type.", "x-ms-discriminator-value": "Custom", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index 6224a1915b1d..28fe62879613 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -156,6 +156,54 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/getFeatureValue": { + "post": { + "tags": [ + "exposureControl" + ], + "operationId": "ExposureControl_GetFeatureValue", + "x-ms-examples": { + "ExposureControl_GetFeatureValue": { + "$ref": "./examples/ExposureControl_GetFeatureValue.json" + } + }, + "description": "Get exposure control feature for specific location.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "exposureControlRequest", + "description": "The exposure control request.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExposureControlRequest" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ExposureControlResponse" + } + }, + "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": [ @@ -4693,6 +4741,36 @@ "description": "The operation error message." } } + }, + "ExposureControlRequest": { + "type": "object", + "description": "The exposure control request.", + "properties": { + "featureName": { + "type": "string", + "description": "The feature name." + }, + "featureType": { + "type": "string", + "description": "The feature type." + } + } + }, + "ExposureControlResponse": { + "type": "object", + "description": "The exposure control response.", + "properties": { + "featureName": { + "type": "string", + "description": "The feature name.", + "readOnly": true + }, + "value": { + "type": "string", + "description": "The feature value.", + "readOnly": true + } + } } }, "parameters": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index d0108dc083a4..ae1d7883c9fb 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -23,6 +23,10 @@ "type": "object", "description": "Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement." }, + "schema": { + "type": "object", + "description": "Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement." + }, "linkedServiceName": { "description": "Linked service reference.", "$ref": "../datafactory.json#/definitions/LinkedServiceReference" @@ -71,6 +75,23 @@ } } }, + "DatasetSchemaDataElement": { + "description": "Columns that define the physical type schema of the dataset.", + "type": "object", + "properties": { + "name": { + "type": "object", + "description": "Name of the schema column. Type: string (or Expression with resultType string)." + }, + "type": { + "type": "object", + "description": "Type of the schema column. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + } + }, "DatasetStorageFormat": { "discriminator": "type", "description": "The format definition of a storage.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 70ec6c7fa6bd..df0ec8fdcc1d 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -109,7 +109,7 @@ "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, - "accountKey": { + "accountKey": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of accountKey in connection string." }, @@ -132,7 +132,7 @@ "properties": { "connectionString": { "type": "object", - "description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference." + "description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "accountKey": { "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", @@ -148,7 +148,7 @@ }, "serviceEndpoint": { "type": "string", - "description": "Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property." + "description": "Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property." }, "servicePrincipalId": { "type": "object", @@ -487,8 +487,8 @@ "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)." + "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", @@ -1603,7 +1603,7 @@ "url" ] }, - "AmazonS3LinkedService": { + "AmazonS3LinkedService": { "x-ms-discriminator-value": "AmazonS3", "description": "Linked service for Amazon S3.", "type": "object", @@ -2082,28 +2082,28 @@ "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.", + "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)", @@ -2141,8 +2141,8 @@ "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).", + "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" } }, @@ -2151,29 +2151,29 @@ "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": { + ] + }, + "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": { @@ -2188,30 +2188,30 @@ "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } - } - }, - "ConcurLinkedService": { - "x-ms-discriminator-value": "Concur", - "description": "Concur Service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Concur Service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ConcurLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ConcurLinkedServiceTypeProperties": { - "description": "Concur Service linked service properties.", + } + }, + "ConcurLinkedService": { + "x-ms-discriminator-value": "Concur", + "description": "Concur Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Concur Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConcurLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ConcurLinkedServiceTypeProperties": { + "description": "Concur Service linked service properties.", "properties": { "clientId": { "description": "Application client_id supplied by Concur App Management.", @@ -2237,37 +2237,37 @@ "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).", + "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": { + ] + }, + "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": { @@ -2282,29 +2282,29 @@ "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": { + } + }, + "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": { @@ -2319,30 +2319,30 @@ "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.", + } + }, + "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)", @@ -2368,38 +2368,38 @@ "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).", + "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.", + ] + }, + "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.", @@ -2453,37 +2453,37 @@ "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).", + "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": { + ] + }, + "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": { @@ -2498,30 +2498,30 @@ "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.", + } + }, + "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)", @@ -2571,38 +2571,38 @@ "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).", + "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.", + ] + }, + "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).", @@ -2696,38 +2696,38 @@ "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).", + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } }, "required": [ "host", "authenticationType" - ] - }, - "HubspotLinkedService": { - "x-ms-discriminator-value": "Hubspot", - "description": "Hubspot Service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Hubspot Service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/HubspotLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "HubspotLinkedServiceTypeProperties": { - "description": "Hubspot Service linked service properties.", + ] + }, + "HubspotLinkedService": { + "x-ms-discriminator-value": "Hubspot", + "description": "Hubspot Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Hubspot Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubspotLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "HubspotLinkedServiceTypeProperties": { + "description": "Hubspot Service linked service properties.", "properties": { "clientId": { "description": "The client ID associated with your Hubspot application.", @@ -2757,37 +2757,37 @@ "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).", + "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.", + ] + }, + "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)", @@ -2838,38 +2838,38 @@ "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).", + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } }, "required": [ "host", "authenticationType" - ] - }, - "JiraLinkedService": { - "x-ms-discriminator-value": "Jira", - "description": "Jira Service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Jira Service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/JiraLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "JiraLinkedServiceTypeProperties": { - "description": "Jira Service linked service properties.", + ] + }, + "JiraLinkedService": { + "x-ms-discriminator-value": "Jira", + "description": "Jira Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Jira Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/JiraLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "JiraLinkedServiceTypeProperties": { + "description": "Jira Service linked service properties.", "properties": { "host": { "description": "The IP address or host name of the Jira service. (e.g. jira.example.com)", @@ -2899,38 +2899,38 @@ "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).", + "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.", + ] + }, + "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)", @@ -2952,36 +2952,36 @@ "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).", + "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": { + ] + }, + "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": { @@ -2996,30 +2996,30 @@ "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.", + } + }, + "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)", @@ -3045,38 +3045,38 @@ "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).", + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } }, "required": [ "endpoint", "clientId" - ] - }, - "PaypalLinkedService": { - "x-ms-discriminator-value": "Paypal", - "description": "Paypal Service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Paypal Service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/PaypalLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "PaypalLinkedServiceTypeProperties": { - "description": "Paypal Service linked service properties.", + ] + }, + "PaypalLinkedService": { + "x-ms-discriminator-value": "Paypal", + "description": "Paypal Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Paypal Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PaypalLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "PaypalLinkedServiceTypeProperties": { + "description": "Paypal Service linked service properties.", "properties": { "host": { "description": "The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)", @@ -3102,38 +3102,38 @@ "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).", + "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.", + ] + }, + "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)", @@ -3188,38 +3188,38 @@ "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).", + "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.", + ] + }, + "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)", @@ -3281,8 +3281,8 @@ "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).", + "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" } }, @@ -3291,29 +3291,29 @@ "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": { + ] + }, + "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": { @@ -3356,30 +3356,30 @@ "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.", + ] + }, + "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)", @@ -3425,38 +3425,38 @@ "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).", + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } }, "required": [ "endpoint", "authenticationType" - ] - }, - "ShopifyLinkedService": { - "x-ms-discriminator-value": "Shopify", - "description": "Shopify Service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Shopify Service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "ShopifyLinkedServiceTypeProperties": { - "description": "Shopify Service linked service properties.", + ] + }, + "ShopifyLinkedService": { + "x-ms-discriminator-value": "Shopify", + "description": "Shopify Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Shopify Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "ShopifyLinkedServiceTypeProperties": { + "description": "Shopify Service linked service properties.", "properties": { "host": { "description": "The endpoint of the Shopify server. (i.e. mystore.myshopify.com)", @@ -3478,37 +3478,37 @@ "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).", + "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.", + ] + }, + "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", @@ -3590,8 +3590,8 @@ "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).", + "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" } }, @@ -3599,30 +3599,30 @@ "host", "port", "authenticationType" - ] - }, - "SquareLinkedService": { - "x-ms-discriminator-value": "Square", - "description": "Square Service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Square Service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/SquareLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "SquareLinkedServiceTypeProperties": { - "description": "Square Service linked service properties.", + ] + }, + "SquareLinkedService": { + "x-ms-discriminator-value": "Square", + "description": "Square Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Square Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/SquareLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SquareLinkedServiceTypeProperties": { + "description": "Square Service linked service properties.", "properties": { "host": { "description": "The URL of the Square instance. (i.e. mystore.mysquare.com)", @@ -3652,8 +3652,8 @@ "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).", + "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" } }, @@ -3661,30 +3661,30 @@ "host", "clientId", "redirectUri" - ] - }, - "XeroLinkedService": { - "x-ms-discriminator-value": "Xero", - "description": "Xero Service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Xero Service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/XeroLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "XeroLinkedServiceTypeProperties": { - "description": "Xero Service linked service properties.", + ] + }, + "XeroLinkedService": { + "x-ms-discriminator-value": "Xero", + "description": "Xero Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Xero Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/XeroLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "XeroLinkedServiceTypeProperties": { + "description": "Xero Service linked service properties.", "properties": { "host": { "description": "The endpoint of the Xero server. (i.e. api.xero.com)", @@ -3710,37 +3710,37 @@ "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).", + "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.", + ] + }, + "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)", @@ -3762,73 +3762,73 @@ "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).", + "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": { + ] + }, + "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" }, - "pwd": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", - "description": "The Azure key vault secret reference of password in connection string." - }, + "pwd": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } - } - }, - "NetezzaLinkedService": { - "x-ms-discriminator-value": "Netezza", - "description": "Netezza linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Netezza linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/NetezzaLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "NetezzaLinkedServiceTypeProperties": { + } + }, + "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": { @@ -3843,30 +3843,30 @@ "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.", + } + }, + "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).", @@ -3888,14 +3888,14 @@ "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).", + "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", @@ -4239,28 +4239,28 @@ "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.", + "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.", @@ -4286,15 +4286,55 @@ "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).", + "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" - ] + ] + }, + "AzureFunctionLinkedService": { + "x-ms-discriminator-value": "AzureFunction", + "description": "Azure Function linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Function linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFunctionLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFunctionLinkedServiceTypeProperties": { + "description": "Azure Function linked service properties.", + "properties": { + "functionAppUrl": { + "description": "The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net.", + "type": "object" + }, + "functionKey": { + "description": "Function or Host key for Azure Function App.", + "$ref": "../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).", + "type": "object" + } + }, + "required": [ + "functionAppUrl" + ] } } } \ 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 index 8e648587a7bb..e2cad0fefd01 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -456,7 +456,7 @@ } } }, - "SqlSource": { + "SqlSource": { "description": "A copy activity SQL source.", "type": "object", "allOf": [ @@ -1134,7 +1134,7 @@ "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", @@ -2105,6 +2105,10 @@ "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", "type": "object" }, + "executionCredential": { + "description": "The package execution credential.", + "$ref": "#/definitions/SSISExecutionCredential" + }, "connectVia": { "description": "The integration runtime reference.", "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" @@ -2152,7 +2156,7 @@ }, "SSISPackageLocation": { "description": "SSIS package location.", - "type" : "object", + "type": "object", "properties": { "packagePath": { "description": "The SSIS package path. Type: string (or Expression with resultType string).", @@ -2200,6 +2204,29 @@ "value" ] }, + "SSISExecutionCredential": { + "description": "SSIS package execution credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecureString", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, "CustomActivity": { "description": "Custom activity type.", "x-ms-discriminator-value": "Custom", @@ -2374,16 +2401,16 @@ "type": "object", "description": "If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean)." }, - "maxConcurrentConnections":{ + "maxConcurrentConnections": { "type": "integer", "minimum": 1, "description": "The max concurrent connections to connect data source at the same time." }, - "enableLogging":{ - "type":"object", + "enableLogging": { + "type": "object", "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." }, - "logStorageSettings":{ + "logStorageSettings": { "description": "Log storage settings customer need to provide when enableLogging is true.", "$ref": "#/definitions/LogStorageSettings" }, @@ -3160,6 +3187,67 @@ "type": "object" } } + }, + "AzureFunctionActivityMethod": { + "description": "The list of HTTP methods supported by a AzureFunctionActivity.", + "type": "string", + "enum": [ + "GET", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "HEAD", + "TRACE" + ], + "x-ms-enum": { + "name": "AzureFunctionActivityMethod", + "modelAsString": true + } + }, + "AzureFunctionActivity": { + "x-ms-discriminator-value": "AzureFunctionActivity", + "description": "Azure Function activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Azure Function activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFunctionActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "AzureFunctionActivityTypeProperties": { + "description": "Azure Function activity type properties.", + "properties": { + "method": { + "description": "Rest API method for target endpoint.", + "$ref": "#/definitions/AzureFunctionActivityMethod" + }, + "functionName": { + "type": "object", + "description": "Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string)" + }, + "headers": { + "type": "object", + "description": "Represents the headers that will be sent to the request. For example, to set the language and type on a request: \"headers\" : { \"Accept-Language\": \"en-us\", \"Content-Type\": \"application/json\" }. Type: string (or Expression with resultType string)." + }, + "body": { + "type": "object", + "description": "Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string)." + } + }, + "required": [ + "method", + "functionName" + ] } } -} +} \ 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 index fb0244650aa1..83402fbecceb 100644 --- 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 @@ -52,6 +52,18 @@ "type": "Microsoft.DataFactory/factories/datasets", "properties": { "type": "AzureBlob", + "schema": [ + { + "name": "col1", + "type": "INT_32" + }, + { + "name": "col2", + "type": "Decimal", + "precision": "38", + "scale": "2" + } + ], "typeProperties": { "folderPath": { "value": "@dataset().MyFolderPath", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_GetFeatureValue.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_GetFeatureValue.json new file mode 100644 index 000000000000..53b0f29b7463 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ExposureControl_GetFeatureValue.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "locationId": "WestEurope", + "exposureControlRequest": { + "featureName": "ADFIntegrationRuntimeSharingRbac", + "featureType": "Feature" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 22 Dec 2018 09:46:07 GMT", + "X-Content-Type-Options": "nosniff" + }, + "body": { + "featureName": "ADFIntegrationRuntimeSharingRbac", + "value": "False" + } + } + } +} \ No newline at end of file diff --git a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/devspaces.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/devspaces.json new file mode 100644 index 000000000000..62bf3c12dfcd --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/devspaces.json @@ -0,0 +1,781 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-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/locations/{location}/checkContainerHostMapping": { + "post": { + "tags": [ + "ContainerHostMappings" + ], + "summary": "Returns container host mapping object for a container host resource ID if an associated controller exists.", + "operationId": "ContainerHostMappings_GetContainerHostMapping", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "containerHostMapping", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerHostMapping" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "location", + "in": "path", + "description": "Location of the container host.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": {} + } + }, + "x-ms-examples": { + "ContainerHostMappingsGetContainerHostMapping": { + "$ref": "./examples/ContainerHostMappingsGetContainerHostMapping_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" + } + } + }, + "/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", + "description": "Parameters for updating the Azure Dev Spaces Controller.", + "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" + } + } + } + } + }, + "definitions": { + "ContainerHostMapping": { + "description": "Container host mapping object specifying the Container host resource ID and its associated Controller resource.", + "properties": { + "containerHostResourceId": { + "description": "ARM ID of the Container Host resource", + "type": "string" + }, + "mappedControllerResourceId": { + "description": "ARM ID of the mapped Controller resource", + "type": "string", + "readOnly": true + } + } + }, + "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" + } + } + }, + "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": [ + "targetContainerHostResourceId", + "targetContainerHostCredentialsBase64" + ], + "properties": { + "provisioningState": { + "description": "Provisioning state of the Azure Dev Spaces Controller.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating", + "Creating", + "Deleting", + "Deleted" + ], + "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", + "readOnly": true + }, + "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 + }, + "orchestratorSpecificConnectionDetails": { + "$ref": "#/definitions/OrchestratorSpecificConnectionDetails" + } + } + }, + "OrchestratorSpecificConnectionDetails": { + "description": "Base class for types that supply values used to connect to container orchestrators", + "properties": { + "instanceType": { + "description": "Gets the Instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "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": { + "description": "Contains information used to connect to a Kubernetes cluster", + "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/2019-01-01-preview/examples/ContainerHostMappingsGetContainerHostMapping_example.json b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ContainerHostMappingsGetContainerHostMapping_example.json new file mode 100644 index 000000000000..bb20aa6343b2 --- /dev/null +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ContainerHostMappingsGetContainerHostMapping_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "location": "eastus", + "containerHostMapping": { + "containerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster" + } + }, + "responses": { + "200": { + "body": { + "containerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster", + "mappedControllerResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.DevSpaces/controllers/myController" + } + } + } +} \ 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/2019-01-01-preview/examples/ControllersCreate_example.json similarity index 82% rename from specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesCreate_example.json rename to specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersCreate_example.json index 31e4a855ac66..b9643c53efe2 100644 --- a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesCreate_example.json +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersCreate_example.json @@ -1,10 +1,10 @@ { "parameters": { - "api-version": "2018-06-01-preview", + "api-version": "2019-01-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "myResourceGroup", "name": "myControllerResource", - "devSpaceCreateParameters": { + "controller": { "location": "eastus", "tags": {}, "sku": { @@ -12,9 +12,8 @@ "tier": "Standard" }, "properties": { - "hostSuffix": "suffix", "targetContainerHostCredentialsBase64": "QmFzZTY0IEVuY29kZWQgVmFsdWUK", - "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster" } } }, @@ -32,9 +31,9 @@ }, "properties": { "provisioningState": "Succeeded", - "hostSuffix": "suffix", + "hostSuffix": "suffix.azds.io", "dataPlaneFqdn": "dataplane.azds.io", - "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster" } } }, @@ -51,9 +50,7 @@ }, "properties": { "provisioningState": "Creating", - "hostSuffix": "suffix", - "dataPlaneFqdn": "dataplane.azds.io", - "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster" } } } 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/2019-01-01-preview/examples/ControllersDelete_example.json similarity index 91% rename from specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesDelete_example.json rename to specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersDelete_example.json index 187f17b7a0b1..a06c752386a4 100644 --- a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesDelete_example.json +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersDelete_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-06-01-preview", + "api-version": "2019-01-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "myResourceGroup", "name": "myControllerResource" 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/2019-01-01-preview/examples/ControllersGet_example.json similarity index 85% rename from specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesGet_example.json rename to specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersGet_example.json index f6deb02784f9..adad206304c5 100644 --- a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesGet_example.json +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersGet_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-06-01-preview", + "api-version": "2019-01-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "myResourceGroup", "name": "myControllerResource" @@ -19,9 +19,9 @@ }, "properties": { "provisioningState": "Succeeded", - "hostSuffix": "suffix", + "hostSuffix": "suffix.azds.io", "dataPlaneFqdn": "dataplane.azds.io", - "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster" } } } 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/2019-01-01-preview/examples/ControllersListByResourceGroup_example.json similarity index 85% rename from specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListByResourceGroup_example.json rename to specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersListByResourceGroup_example.json index 06ec0347ede0..5d4bae4c29ec 100644 --- a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListByResourceGroup_example.json +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersListByResourceGroup_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-06-01-preview", + "api-version": "2019-01-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "myResourceGroup" }, @@ -20,9 +20,9 @@ }, "properties": { "provisioningState": "Succeeded", - "hostSuffix": "suffix", + "hostSuffix": "suffix.azds.io", "dataPlaneFqdn": "dataplane.azds.io", - "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster" } } ] 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/2019-01-01-preview/examples/ControllersListConnectionDetails_example.json similarity index 73% rename from specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListConnectionDetails_example.json rename to specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersListConnectionDetails_example.json index 5ef702bf8155..101851f45cf7 100644 --- a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesListConnectionDetails_example.json +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersListConnectionDetails_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-06-01-preview", + "api-version": "2019-01-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "myResourceGroup", "name": "myControllerResource" @@ -11,8 +11,6 @@ "connectionDetailsList": [ { "authKey": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", - "workspaceStorageAccountName": "storageAccount", - "workspaceStorageSasToken": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", "orchestratorSpecificConnectionDetails": { "instanceType": "Kubernetes", "kubeConfig": "0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" 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/2019-01-01-preview/examples/ControllersList_example.json similarity index 85% rename from specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesList_example.json rename to specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersList_example.json index 7c34aed6946e..799d2f698fa7 100644 --- a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesList_example.json +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersList_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-06-01-preview", + "api-version": "2019-01-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { @@ -19,9 +19,9 @@ }, "properties": { "provisioningState": "Succeeded", - "hostSuffix": "suffix", + "hostSuffix": "suffix.azds.io", "dataPlaneFqdn": "dataplane.azds.io", - "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedCluster/myCluster" + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster" } } ] 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/2019-01-01-preview/examples/ControllersUpdate_example.json similarity index 50% rename from specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesUpdate_example.json rename to specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersUpdate_example.json index ac792de99122..8f561a62b5b0 100644 --- a/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2018-06-01-preview/examples/ControllerResourcesUpdate_example.json +++ b/specification/devspaces/resource-manager/Microsoft.DevSpaces/preview/2019-01-01-preview/examples/ControllersUpdate_example.json @@ -1,10 +1,10 @@ { "parameters": { - "api-version": "2018-06-01-preview", + "api-version": "2019-01-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "myResourceGroup", "name": "myControllerResource", - "devSpaceUpdateParameters": { + "controllerUpdateParameters": { "tags": { "key": "value" } @@ -26,28 +26,9 @@ }, "properties": { "provisioningState": "Succeeded", - "hostSuffix": "suffix", + "hostSuffix": "suffix.azds.io", "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" + "targetContainerHostResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster" } } } diff --git a/specification/devspaces/resource-manager/readme.go.md b/specification/devspaces/resource-manager/readme.go.md index 38d4496042d2..f81c7fda558f 100644 --- a/specification/devspaces/resource-manager/readme.go.md +++ b/specification/devspaces/resource-manager/readme.go.md @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2018-06-01-preview + - tag: package-2019-01-01-preview ``` ### Tag: package-2018-06-01-preview and go @@ -23,4 +24,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-01-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-01-01-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/devspaces/resource-manager/readme.md b/specification/devspaces/resource-manager/readme.md index 2e956c19fa8f..4920ccae6b7a 100644 --- a/specification/devspaces/resource-manager/readme.md +++ b/specification/devspaces/resource-manager/readme.md @@ -27,7 +27,16 @@ These are the global settings for the DevSpaces API. title: DevSpacesManagementClient description: Dev Spaces Client openapi-type: arm -tag: package-2018-06-01-preview +tag: package-2019-01-01-preview +``` + +### Tag: package-2019-01-01-preview + +These settings apply only when `--tag=package-2019-01-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2019-01-01-preview' +input-file: +- Microsoft.DevSpaces/preview/2019-01-01-preview/devspaces.json ``` ### Tag: package-2018-06-01-preview @@ -95,6 +104,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devspaces ``` yaml $(java) && $(multiapi) batch: - tag: package-2018-06-01-preview + - tag: package-2019-01-01-preview ``` ### Tag: package-2018-06-01-preview and java @@ -108,4 +118,17 @@ java: output-folder: $(azure-libraries-for-java-folder)/devspaces/resource-manager/v2018_06_01_preview regenerate-manager: true generate-interface: true +``` + +### Tag: package-2019-01-01-preview and java + +These settings apply only when `--tag=2019-01-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2019-01-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devspaces.v2019_01_01_preview + output-folder: $(azure-libraries-for-java-folder)/devspaces/resource-manager/v2019_01_01_preview +regenerate-manager: true +generate-interface: true ``` \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ClaimAnyVm.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ClaimAnyVm.json index ce186cf5cec0..8e5a46ad07ea 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ClaimAnyVm.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ClaimAnyVm.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "name": "{devtestlab-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "monitor": "true" }, "responses": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateEnvironment.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateEnvironment.json index e4f72214e0b8..2555be1b6585 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateEnvironment.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateEnvironment.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "name": "{devtestlab-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "labVirtualMachineCreationParameter": { "properties": { "osType": "Linux", diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json index d80294795e2c..b6f5160c688c 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "name": "{devtestlab-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "lab": { "properties": { "labStorageType": "{Standard|Premium}" diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Delete.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Delete.json index 69dc3d95bebe..d30cbc0c6b1d 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Delete.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Delete.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "name": "{devtestlab-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_GenerateUploadUri.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_GenerateUploadUri.json index a84e61122adb..297f5d014680 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_GenerateUploadUri.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_GenerateUploadUri.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "name": "{devtestlab-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "generateUploadUriParameter": { "blobName": "{blob-name}" } diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json index 1f56023f25b8..2fb63de949c6 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "name": "{devtestlab-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListByResourceGroup.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListByResourceGroup.json index 6cc3c30ad64d..4e37aac9e6d5 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListByResourceGroup.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListByResourceGroup.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListBySubscription.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListBySubscription.json index cdae8b2f96e6..fb715b6a40cb 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListBySubscription.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListBySubscription.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "{subscription-id}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json index 242a31478233..7aa97b304fc2 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "name": "{devtestlab-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "lab": { "properties": { "labStorageType": "Premium" diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json index 762f1f69fc44..f74626609568 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Claim.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Claim.json index 735b68da17b0..295b161bbf2c 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Claim.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Claim.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json index dfe3a0c00834..082c8e29c18a 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "labVirtualMachine": { "properties": { "osType": "Linux", diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Delete.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Delete.json index ae456eab47a4..84c979344762 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Delete.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Delete.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Get.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Get.json index a09a6fa966fa..dee2632be7fc 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Get.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Get.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json index 6fc0184759c7..d95c74f710cd 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json index c8d5079322db..f9ad5030d076 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Redeploy.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Redeploy.json index 9f39bf9443c4..f6cea45cb0f8 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Redeploy.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Redeploy.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "monitor": "true" }, "responses": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Resize.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Resize.json index 8bb556bf7b27..823b697d9851 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Resize.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Resize.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "monitor": "true", "resizeLabVirtualMachineProperties": { "size": "Standard_A4_v2" diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Restart.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Restart.json index 9f39bf9443c4..f6cea45cb0f8 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Restart.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Restart.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "monitor": "true" }, "responses": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Start.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Start.json index 9f39bf9443c4..f6cea45cb0f8 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Start.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Start.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "monitor": "true" }, "responses": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Stop.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Stop.json index 735b68da17b0..295b161bbf2c 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Stop.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Stop.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_UnClaim.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_UnClaim.json index 9f39bf9443c4..f6cea45cb0f8 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_UnClaim.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_UnClaim.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "monitor": "true" }, "responses": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Update.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Update.json index 991168c9b4e7..30b5739db955 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Update.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Update.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualmachine-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "labVirtualMachine": { "properties": { "notes": "Updated notes" diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_CreateOrUpdate.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_CreateOrUpdate.json index 3412abbdc64d..b9ae334414e9 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_CreateOrUpdate.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_CreateOrUpdate.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualnetwork-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "virtualNetwork": { "location": "{azure-location}", "tags": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Delete.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Delete.json index 045990ab9fa5..88cdf9309b3d 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Delete.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Delete.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualnetwork-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Get.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Get.json index 7104de5c9cda..297ad649a413 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Get.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Get.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualnetwork-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json index b905f79e2338..79f9cb3e849e 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", - "api-version": "2018-10-15-preview" + "api-version": "2018-09-15" }, "responses": { "200": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json index d439c40e4cd7..00064846e0bb 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json @@ -4,7 +4,7 @@ "resourceGroupName": "myResourceGroup", "labName": "{devtestlab-name}", "name": "{virtualnetwork-name}", - "api-version": "2018-10-15-preview", + "api-version": "2018-09-15", "virtualNetwork": { "properties": { "subnetOverrides": [ diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/edgegateway.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/edgegateway.json new file mode 100644 index 000000000000..4d2f79928dd1 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/edgegateway.json @@ -0,0 +1,3998 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-07-01", + "title": "DataBoxEdgeManagementClient" + }, + "host": "management.azure.com", + "schemes": [ "https" ], + "consumes": [ "application/json" ], + "produces": [ "application/json" ], + "paths": { + "/providers/Microsoft.DataBoxEdge/operations": { + "get": { + "tags": [ "Operations" ], + "summary": "Lists all the operations supported.", + "operationId": "Operations_List", + "parameters": [ { "$ref": "#/parameters/apiVersionParameter" } ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/OperationsList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/OperationsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ "Devices" ], + "description": "Retrieves all data box edge/gateway devices in a subscription.", + "operationId": "Devices_ListBySubscription", + "parameters": [ + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/apiVersionParameter" }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of data box edge/gateway devices.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetBySubscription": { + "$ref": "./examples/DataBoxEdgeDeviceGetBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ "Devices" ], + "description": "Retrieves all data box edge/gateway devices in a resource group.", + "operationId": "Devices_ListByResourceGroup", + "parameters": [ + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of data box edge/gateway devices.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByResourceGroup": { + "$ref": "./examples/DataBoxEdgeDeviceGetByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": { + "get": { + "tags": [ "Devices" ], + "description": "Returns the properties of the data box edge/gateway device.", + "operationId": "Devices_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The data box edge/gateway device.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByName": { + "$ref": "./examples/DataBoxEdgeDeviceGetByName.json" + } + } + }, + "put": { + "tags": [ "Devices" ], + "description": "Creates or updates a Data Box Edge/Gateway resource.", + "operationId": "Devices_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "DataBoxEdgeDevice", + "in": "body", + "description": "The resource object.", + "required": true, + "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Successfully created or updated the resource.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DataBoxEdgeDevicePut": { + "$ref": "./examples/DataBoxEdgeDevicePut.json" + } + } + }, + "delete": { + "tags": [ "Devices" ], + "description": "Deletes the data box edge/gateway device.", + "operationId": "Devices_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully deleted the resource." }, + "202": { "description": "Accepted the request to delete the resource." }, + "204": { "description": "The resource is already deleted." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DataBoxEdgeDeviceDelete": { + "$ref": "./examples/DataBoxEdgeDeviceDelete.json" + } + } + }, + "patch": { + "tags": [ "Devices" ], + "description": "Updates data box edge/gateway device.", + "operationId": "Devices_Update", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The device update parameters.", + "required": true, + "schema": { "$ref": "#/definitions/DataBoxEdgeDevicePatch" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The data box edge/gateway device has been successfully updated.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDevice" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "DataBoxEdgeDevicePatch": { + "$ref": "./examples/DataBoxEdgeDevicePatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": { + "get": { + "tags": [ "Alerts" ], + "description": "Retrieves all the alerts for a data box edge/gateway device.", + "operationId": "Alerts_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The collection of alerts.", + "schema": { "$ref": "#/definitions/AlertList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "AlertGetAllInDevice": { + "$ref": "./examples/AlertGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": { + "get": { + "tags": [ "Alerts" ], + "summary": "Returns an alert by name.", + "operationId": "Alerts_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the alert which needs to be retrieved.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The alert details.", + "schema": { "$ref": "#/definitions/Alert" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "AlertGet": { + "$ref": "./examples/AlertGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": { + "get": { + "tags": [ "BandwidthSchedules" ], + "description": "Returns all the bandwidth Schedules for a data box edge/gateway device.", + "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The collection of bandwidth settings.", + "schema": { "$ref": "#/definitions/BandwidthSchedulesList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "BandwidthScheduleGetAllInDevice": { + "$ref": "./examples/BandwidthScheduleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": { + "get": { + "tags": [ "BandwidthSchedules" ], + "description": "Returns the properties of the specified bandwidth schedule name.", + "operationId": "BandwidthSchedules_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The bandwidth settings.", + "schema": { "$ref": "#/definitions/BandwidthSchedule" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "BandwidthScheduleGet": { + "$ref": "./examples/BandwidthScheduleGet.json" + } + } + }, + "put": { + "tags": [ "BandwidthSchedules" ], + "description": "Creates or updates a bandwidth schedule.", + "operationId": "BandwidthSchedules_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name which needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The bandwidth schedule to be added or updated.", + "required": true, + "schema": { "$ref": "#/definitions/BandwidthSchedule" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Successfully created or updated the bandwidth schedule.", + "schema": { "$ref": "#/definitions/BandwidthSchedule" } + }, + "202": { "description": "Accepted the request to create or update the bandwidth schedule." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthSchedulePut": { + "$ref": "./examples/BandwidthSchedulePut.json" + } + } + }, + "delete": { + "tags": [ "BandwidthSchedules" ], + "description": "Deletes the specified bandwidth schedule.", + "operationId": "BandwidthSchedules_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully deleted the bandwidth schedule." }, + "202": { "description": "Accepted the request to delete the bandwidth schedule." }, + "204": { "description": "Successfully deleted the bandwidth schedule." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthScheduleDelete": { + "$ref": "./examples/BandwidthScheduleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": { + "post": { + "tags": [ "Devices" ], + "summary": "Downloads the updates on the data box edge/gateway device.", + "operationId": "Devices_DownloadUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully downloaded the updates on the device." }, + "202": { "description": "Accepted the request to download the updates on the device." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DownloadUpdatesPost": { + "$ref": "./examples/DownloadUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": { + "put": { + "tags": [ "Devices" ], + "description": "Creates or updates the extended info of the data box edge/gateway device.", + "operationId": "Devices_CreateOrUpdateExtendedInfo", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The device extended information.", + "required": true, + "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The extended information on the device has been successfully created/updated.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "ExtendedInfoPut": { + "$ref": "./examples/ExtendedInfoPut.json" + } + } + }, + "post": { + "tags": [ "Devices" ], + "description": "Returns the extended information of the specified data box edge/gateway device.", + "operationId": "Devices_GetExtendedInformation", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The data box edge/gateway device extended information.", + "schema": { "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "ExtendedInfoPost": { + "$ref": "./examples/ExtendedInfoPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": { + "post": { + "tags": [ "Devices" ], + "summary": "Installs the updates on the data box edge/gateway device.", + "operationId": "Devices_InstallUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully installed updates on the device." }, + "202": { "description": "Accepted the request to install updates on the device." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "InstallUpdatesPost": { + "$ref": "./examples/InstallUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": { + "get": { + "tags": [ "Devices" ], + "description": "Returns the network settings of the specified data box edge/gateway device.", + "operationId": "Devices_GetNetworkSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The device network settings.", + "schema": { "$ref": "#/definitions/NetworkSettings" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "NetworkSettingsGet": { + "$ref": "./examples/NetworkSettingsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": { + "get": { + "tags": [ "OperationsStatus" ], + "summary": "Returns the job details of the specified job on a data box edge/gateway device.", + "operationId": "OperationsStatus_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The job name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The job details.", + "schema": { "$ref": "#/definitions/Job" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "OperationsStatusGet": { + "$ref": "./examples/OperationsStatusGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": { + "get": { + "tags": [ "Orders" ], + "summary": "List all the orders related to the device.", + "operationId": "Orders_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "List all orders placed for the Data Box Edge Device", + "schema": { "$ref": "#/definitions/OrderList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "OrderGetAllInDevice": { + "$ref": "./examples/OrderGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": { + "get": { + "tags": [ "Orders" ], + "summary": "Get a specific order by name.", + "operationId": "Orders_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The order with specified name in the given device.", + "schema": { "$ref": "#/definitions/Order" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "OrderGet": { + "$ref": "./examples/OrderGet.json" + } + } + }, + "put": { + "tags": [ "Orders" ], + "summary": "Creates or updates an order.", + "operationId": "Orders_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the edge device for which order needs to be added or updated.", + "required": true, + "type": "string" + }, + { + "name": "order", + "in": "body", + "description": "Order to be added.", + "required": true, + "schema": { "$ref": "#/definitions/Order" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Successfully created or updated the order.", + "schema": { "$ref": "#/definitions/Order" } + }, + "202": { "description": "Accepted the request to create or update the order." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderPut": { + "$ref": "./examples/OrderPut.json" + } + } + }, + "delete": { + "tags": [ "Orders" ], + "summary": "Deletes the order related to the device.", + "operationId": "Orders_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully deleted the order." }, + "202": { "description": "Accepted the request to delete the order." }, + "204": { "description": "The order is already deleted." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderDelete": { + "$ref": "./examples/OrderDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": { + "get": { + "tags": [ "Roles" ], + "description": "Lists all the roles configured in a data box edge/gateway device.", + "operationId": "Roles_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "List of all roles configured in the device.", + "schema": { "$ref": "#/definitions/RoleList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "RoleGetAllInDevice": { + "$ref": "./examples/RoleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": { + "get": { + "tags": [ "Roles" ], + "description": "Get a specific role by name.", + "operationId": "Roles_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of role to be fetched.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The role with specified name in the given device.", + "schema": { "$ref": "#/definitions/Role" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "RoleGet": { + "$ref": "./examples/RoleGet.json" + } + } + }, + "put": { + "tags": [ "Roles" ], + "description": "Create or update a role.", + "operationId": "Roles_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device in which the role needs to be added or updated.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the role to be updated.", + "required": true, + "type": "string" + }, + { + "name": "role", + "in": "body", + "description": "Role to be added.", + "required": true, + "schema": { "$ref": "#/definitions/Role" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Successfully created or updated the role.", + "schema": { "$ref": "#/definitions/Role" } + }, + "202": { "description": "Accepted the request to create or update the role." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RolePut": { + "$ref": "./examples/RolePut.json" + } + } + }, + "delete": { + "tags": [ "Roles" ], + "description": "Deletes the role on the gateway device.", + "operationId": "Roles_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the role which needs to be deleted.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully deleted the role." }, + "202": { "description": "Accepted the request to delete the role." }, + "204": { "description": "The role is already deleted." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RoleDelete": { + "$ref": "./examples/RoleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": { + "post": { + "tags": [ "Devices" ], + "summary": "Scans for updates on a data box edge/gateway device.", + "operationId": "Devices_ScanForUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully scanned the device for updates." }, + "202": { "description": "Accepted the request to scan for updates on the device." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ScanForUpdatesPost": { + "$ref": "./examples/ScanForUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": { + "post": { + "tags": [ "Devices" ], + "description": "Updates the security settings on a data box edge/gateway device.", + "operationId": "Devices_CreateOrUpdateSecuritySettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "securitySettings", + "in": "body", + "description": "The security settings.", + "required": true, + "schema": { "$ref": "#/definitions/SecuritySettings" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "202": { "description": "Accepted the request to update the security settings." }, + "204": { "description": "Updated the security settings." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareGetAllInDevice": { + "$ref": "./examples/SecuritySettingsUpdatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": { + "get": { + "tags": [ "Shares" ], + "summary": "Lists all the shares in a data box edge/gateway device.", + "operationId": "Shares_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The collection of all shares on the device.", + "schema": { "$ref": "#/definitions/ShareList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "ShareGetAllInDevice": { + "$ref": "./examples/ShareGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": { + "get": { + "tags": [ "Shares" ], + "summary": "Returns a particular share by name.", + "operationId": "Shares_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the share.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The share.", + "schema": { "$ref": "#/definitions/Share" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "ShareGet": { + "$ref": "./examples/ShareGet.json" + } + } + }, + "put": { + "tags": [ "Shares" ], + "summary": "Creates a new share or update an existing share on the device.", + "operationId": "Shares_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the share which needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "share", + "in": "body", + "description": "The share object containing the share details.", + "required": true, + "schema": { "$ref": "#/definitions/Share" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Successfully created or updated the share.", + "schema": { "$ref": "#/definitions/Share" } + }, + "202": { "description": "Accepted the request to create or update the share." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SharePut": { + "$ref": "./examples/SharePut.json" + } + } + }, + "delete": { + "tags": [ "Shares" ], + "description": "Deletes the share on the data box edge/gateway device.", + "operationId": "Shares_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the share which needs to be deleted.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully deleted the share." }, + "202": { "description": "Accepted the request to delete the share." }, + "204": { "description": "The share is already deleted." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareDelete": { + "$ref": "./examples/ShareDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": { + "post": { + "tags": [ "Shares" ], + "summary": "Triggers a manual refresh of the share metadata with the actual cloud storage account.", + "operationId": "Shares_Refresh", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the share.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully refreshed the share on the device." }, + "202": { "description": "Accepted the request to refresh the share on the device." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareRefreshPost": { + "$ref": "./examples/ShareRefreshPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": { + "get": { + "tags": [ "StorageAccountCredentials" ], + "summary": "Gets all the storage account credentials in a data box edge/gateway device.", + "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The collection of storage account credentials.", + "schema": { "$ref": "#/definitions/StorageAccountCredentialList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "SACGetAllInDevice": { + "$ref": "./examples/SACGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": { + "get": { + "tags": [ "StorageAccountCredentials" ], + "description": "Gets the properties of the specified storage account credential.", + "operationId": "StorageAccountCredentials_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the storage account credential to be fetched.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The storage account credential.", + "schema": { "$ref": "#/definitions/StorageAccountCredential" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "SACGet": { + "$ref": "./examples/SACGet.json" + } + } + }, + "put": { + "tags": [ "StorageAccountCredentials" ], + "description": "Creates or updates the storage account credential.", + "operationId": "StorageAccountCredentials_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountCredential", + "in": "body", + "description": "The storage account credential to be added or updated.", + "required": true, + "schema": { "$ref": "#/definitions/StorageAccountCredential" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Successfully created or updated the storage account credential.", + "schema": { "$ref": "#/definitions/StorageAccountCredential" } + }, + "202": { "description": "Accepted the request to create or update the storage account credential." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACPut": { + "$ref": "./examples/SACPut.json" + } + } + }, + "delete": { + "tags": [ "StorageAccountCredentials" ], + "description": "Deletes the storage account credential.", + "operationId": "StorageAccountCredentials_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the storage account credential.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully deleted the storage account credential." }, + "202": { "description": "Accepted the request to delete the storage account credential." }, + "204": { "description": "The storage account credential is already deleted." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACDelete": { + "$ref": "./examples/SACDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": { + "get": { + "tags": [ "Triggers" ], + "description": "List all the triggers configured in the device.", + "operationId": "Triggers_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "List all triggers configured in the device", + "schema": { "$ref": "#/definitions/TriggerList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "TriggerGetAllInDevice": { + "$ref": "./examples/TriggerGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": { + "get": { + "tags": [ "Triggers" ], + "description": "Get a specific trigger by name.", + "operationId": "Triggers_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of trigger to be fetched.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The trigger with specified name in the given device.", + "schema": { "$ref": "#/definitions/Trigger" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "TriggerGet": { + "$ref": "./examples/TriggerGet.json" + } + } + }, + "put": { + "tags": [ "Triggers" ], + "description": "Create or update a trigger.", + "operationId": "Triggers_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the edge device in which trigger needs to be added or updated.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of trigger to be added or updated.", + "required": true, + "type": "string" + }, + { + "name": "trigger", + "in": "body", + "description": "Trigger to be added.", + "required": true, + "schema": { "$ref": "#/definitions/Trigger" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Successfully created or updated the trigger.", + "schema": { "$ref": "#/definitions/Trigger" } + }, + "202": { "description": "Accepted the request to create or update the trigger." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerPut": { + "$ref": "./examples/TriggerPut.json" + } + } + }, + "delete": { + "tags": [ "Triggers" ], + "description": "Deletes the trigger on the gateway device.", + "operationId": "Triggers_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Name of the device.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the trigger which needs to be deleted.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully deleted the trigger." }, + "202": { "description": "Accepted the request to delete the trigger." }, + "204": { "description": "The trigger is already deleted." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerDelete": { + "$ref": "./examples/TriggerDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": { + "get": { + "tags": [ "Devices" ], + "summary": "Returns information about the availability of updates as per the last scan done on the device. It also returns information about any ongoing download or install jobs on the device.", + "operationId": "Devices_GetUpdateSummary", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The update summary.", + "schema": { "$ref": "#/definitions/UpdateSummary" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "UpdateSummaryGet": { + "$ref": "./examples/UpdateSummaryGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": { + "post": { + "tags": [ "Devices" ], + "description": "Uploads registration certificate for the device.", + "operationId": "Devices_UploadCertificate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The upload certificate request.", + "required": true, + "schema": { "$ref": "#/definitions/UploadCertificateRequest" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Uploaded the registration certificate.", + "schema": { "$ref": "#/definitions/UploadCertificateResponse" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "UploadCertificatePost": { + "$ref": "./examples/UploadCertificatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": { + "get": { + "tags": [ "Users" ], + "description": "Returns all the users registered in a data box edge/gateway device.", + "operationId": "Users_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The collection of all users on the device.", + "schema": { "$ref": "#/definitions/UserList" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/UserGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": { + "get": { + "tags": [ "Users" ], + "description": "Returns the properties of the specified user.", + "operationId": "Users_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user who needs to be retrieved.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "The user details.", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { + "UserGet": { + "$ref": "./examples/UserGet.json" + } + } + }, + "put": { + "tags": [ "Users" ], + "description": "Create a new user or update an existing user's information on a data box edge/gateway device.", + "operationId": "Users_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user who needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "The user object containing the user details and encrypted password.", + "required": true, + "schema": { "$ref": "#/definitions/User" } + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { + "description": "Successfully created or updated the user.", + "schema": { "$ref": "#/definitions/User" } + }, + "202": { "description": "Accepted the request to create or update the user." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserPut": { + "$ref": "./examples/UserPut.json" + } + } + }, + "delete": { + "tags": [ "Users" ], + "description": "Deletes the user on a databox edge/gateway device.", + "operationId": "Users_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user who needs to be deleted.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/subscriptionIdParameter" }, + { "$ref": "#/parameters/resourceGroupNameParameter" }, + { "$ref": "#/parameters/apiVersionParameter" } + ], + "responses": { + "200": { "description": "Successfully deleted the user." }, + "202": { "description": "Accepted the request to delete the user." }, + "204": { "description": "The user is already deleted." }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserDelete": { + "$ref": "./examples/UserDelete.json" + } + } + } + } + }, + "definitions": { + "Address": { + "description": "The shipping address of the customer.", + "required": [ "addressLine1", "addressLine2", "addressLine3", "postalCode", "city", "state", "country" ], + "type": "object", + "properties": { + "addressLine1": { + "description": "The address line1.", + "type": "string" + }, + "addressLine2": { + "description": "The address line2.", + "type": "string" + }, + "addressLine3": { + "description": "The address line3.", + "type": "string" + }, + "postalCode": { + "description": "The postal code.", + "type": "string" + }, + "city": { + "description": "The city name.", + "type": "string" + }, + "state": { + "description": "The state name.", + "type": "string" + }, + "country": { + "description": "The country name.", + "type": "string" + } + } + }, + "Alert": { + "description": "Alert on the data box edge/gateway device.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Properties of alert.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "AlertErrorDetails": { + "description": "Error details for the alert.", + "type": "object", + "properties": { + "errorCode": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Error Message.", + "type": "string", + "readOnly": true + }, + "occurrences": { + "format": "int32", + "description": "Number of occurrences.", + "type": "integer", + "readOnly": true + } + } + }, + "AlertList": { + "description": "Collection of Alerts.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { "$ref": "#/definitions/Alert" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "AlertProperties": { + "description": "Properties of alert.", + "type": "object", + "properties": { + "title": { + "description": "Title of the alert.", + "type": "string", + "readOnly": true + }, + "alertType": { + "description": "Type of the alert.", + "type": "string", + "readOnly": true + }, + "appearedAtDateTime": { + "format": "date-time", + "description": "UTC time at which the alert appeared.", + "type": "string", + "readOnly": true + }, + "recommendation": { + "description": "Recommendation for acting on the alert.", + "type": "string", + "readOnly": true + }, + "severity": { + "description": "Severity of the alert.", + "enum": [ "Informational", "Warning", "Critical" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AlertSeverity", + "modelAsString": true + } + }, + "errorDetails": { + "$ref": "#/definitions/AlertErrorDetails", + "description": "Error details of the alert.", + "readOnly": true + }, + "detailedInformation": { + "description": "Detailed information about the alert.", + "type": "object", + "additionalProperties": { "type": "string" }, + "readOnly": true + } + } + }, + "ARMBaseModel": { + "description": "Represents the base class for all object models.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "AsymmetricEncryptedSecret": { + "description": "Represent the secrets intended for encryption with asymmetric key pair.", + "required": [ "value", "encryptionAlgorithm" ], + "type": "object", + "properties": { + "value": { + "description": "The value of the secret.", + "type": "string" + }, + "encryptionCertThumbprint": { + "description": "Thumbprint certificate that was used to encrypt \"Value\". If the value in unencrypted, it will be null.", + "type": "string" + }, + "encryptionAlgorithm": { + "description": "The algorithm used to encrypt \"Value\".", + "enum": [ "None", "AES256", "RSAES_PKCS1_v_1_5" ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionAlgorithm", + "modelAsString": true + } + } + } + }, + "Authentication": { + "description": "Authentication mechanism for IoT devices.", + "type": "object", + "properties": { + "symmetricKey": { + "$ref": "#/definitions/SymmetricKey", + "description": "Symmetric key for authentication." + } + } + }, + "AzureContainerInfo": { + "description": "Azure container mapping of the endpoint.", + "required": [ "storageAccountCredentialId", "containerName", "dataFormat" ], + "type": "object", + "properties": { + "storageAccountCredentialId": { + "description": "ID of the Storage account credential to be used for accessing storage.", + "type": "string" + }, + "containerName": { + "description": "Container name (Based on the data format specified, represents the name of Azure file/ Page blob / Block blob).", + "type": "string" + }, + "dataFormat": { + "description": "Storage format used for the file represented by the share.", + "enum": [ "BlockBlob", "PageBlob", "AzureFile" ], + "type": "string", + "x-ms-enum": { + "name": "AzureContainerDataFormat", + "modelAsString": true + } + } + } + }, + "BandwidthSchedule": { + "description": "The bandwidth schedule details.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/BandwidthScheduleProperties", + "description": "The properties of the bandwidth schedule.", + "x-ms-client-flatten": true + } + } + }, + "BandwidthScheduleProperties": { + "description": "The properties of the bandwidth schedule.", + "required": [ "start", "stop", "rateInMbps", "days" ], + "type": "object", + "properties": { + "start": { + "description": "The start time of the schedule in UTC.", + "type": "string" + }, + "stop": { + "description": "The stop time of the schedule in UTC.", + "type": "string" + }, + "rateInMbps": { + "format": "int32", + "description": "The bandwidth rate in Mbps.", + "type": "integer" + }, + "days": { + "description": "The days of the week when this schedule is applicable.", + "type": "array", + "items": { + "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + } + } + }, + "BandwidthSchedulesList": { + "description": "The collection of bandwidth schedules.", + "type": "object", + "properties": { + "value": { + "description": "The list of bandwidth schedules.", + "type": "array", + "items": { "$ref": "#/definitions/BandwidthSchedule" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ClientAccessRight": { + "description": "The mapping between a particular client ip and the type of access client has on the NFS share.", + "required": [ "client", "accessPermission" ], + "type": "object", + "properties": { + "client": { + "description": "Ip of the client.", + "type": "string" + }, + "accessPermission": { + "description": "Type of access to be allowed for the client.", + "enum": [ "NoAccess", "ReadOnly", "ReadWrite" ], + "type": "string", + "x-ms-enum": { + "name": "ClientPermissionType", + "modelAsString": true + } + } + } + }, + "CloudError": { + "description": "An error response from the service.", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The error details." + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "An error response from the service.", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "type": "string" + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "type": "array", + "items": { "$ref": "#/definitions/CloudErrorBody" } + } + }, + "x-ms-external": true + }, + "ContactDetails": { + "description": "Contains all the contact details of the customer.", + "required": [ "contactPerson", "companyName", "phone", "emailList" ], + "type": "object", + "properties": { + "contactPerson": { + "description": "Gets or sets the contact person.", + "type": "string" + }, + "companyName": { + "description": "Gets or sets the name of the company.", + "type": "string" + }, + "phone": { + "description": "Gets or sets the phone number.", + "type": "string" + }, + "emailList": { + "description": "Gets or sets the email list.", + "type": "array", + "items": { "type": "string" } + } + } + }, + "DataBoxEdgeDevice": { + "description": "The Data Box Edge/Gateway device.", + "required": [ "location" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "location": { + "description": "The location of the device. This 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 device cannot be changed once it is created, but if an identical geo region is specified on update the request will succeed.", + "type": "string", + "x-ms-mutability": [ "read", "create" ] + }, + "tags": { + "description": "The list of tags that describe the device. These tags can be used in viewing and grouping this device (across resource groups).", + "type": "object", + "additionalProperties": { "type": "string" } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku type." + }, + "etag": { + "description": "The etag of the devices.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceProperties", + "description": "The properties of the Data Box Edge/Gateway device.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfo": { + "description": "The extended Info of the Data Box Edge/Gateway device.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties", + "description": "The extended info properties.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfoProperties": { + "description": "The properties of the Data Box Edge/Gateway device extended info.", + "required": [ "integrityKey" ], + "type": "object", + "properties": { + "integrityKey": { + "description": "The Channel Integrity Key (CIK) of the device.", + "type": "string" + }, + "encryptionKeyThumbprint": { + "description": "The certificate thumbprint that was used to encrypt the Channel Integrity Key (CIK).", + "type": "string" + }, + "encryptionKey": { + "description": "The Channel Integrity Key (CIK) of the device.", + "type": "string" + }, + "resourceKey": { + "description": "The Resource Id of the Resource.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDeviceList": { + "description": "The collection of Data Box Edge/Gateway devices.", + "type": "object", + "properties": { + "value": { + "description": "The list of Data Box Edge/Gateway devices.", + "type": "array", + "items": { "$ref": "#/definitions/DataBoxEdgeDevice" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevicePatch": { + "description": "The Data Box Edge/Gateway device patch.", + "type": "object", + "properties": { + "tags": { + "description": "The tags attached to the Data Box Edge/Gateway resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "DataBoxEdgeDeviceProperties": { + "description": "The properties of the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "dataBoxEdgeDeviceStatus": { + "description": "The status of the Data Box Edge/Gateway device.", + "enum": [ "ReadyToSetup", "Online", "Offline", "NeedsAttention", "Disconnected", "PartiallyDisconnected" ], + "type": "string", + "x-ms-enum": { + "name": "DataBoxEdgeDeviceStatus", + "modelAsString": true + } + }, + "serialNumber": { + "description": "The Serial Number of Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The Description of the Data Box Edge/Gateway device.", + "type": "string" + }, + "modelDescription": { + "description": "The description of the Data Box Edge/Gateway device model.", + "type": "string" + }, + "deviceType": { + "description": "The type of the Data Box Edge/Gateway device.", + "enum": [ "DataBoxEdgeDevice" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": true + } + }, + "friendlyName": { + "description": "The Data Box Edge/Gateway device name.", + "type": "string" + }, + "culture": { + "description": "The Data Box Edge/Gateway device culture.", + "type": "string", + "readOnly": true + }, + "deviceModel": { + "description": "The Data Box Edge/Gateway device model.", + "type": "string", + "readOnly": true + }, + "deviceSoftwareVersion": { + "description": "The Data Box Edge/Gateway device software version.", + "type": "string", + "readOnly": true + }, + "deviceLocalCapacity": { + "format": "int64", + "description": "The Data Box Edge/Gateway device local capacity in MB.", + "type": "integer", + "readOnly": true + }, + "timeZone": { + "description": "The Data Box Edge/Gateway device timezone.", + "type": "string", + "readOnly": true + }, + "deviceHcsVersion": { + "description": "The device software version number of the device (eg: 1.2.18105.6).", + "type": "string", + "readOnly": true + }, + "configuredRoleTypes": { + "description": "Type of compute roles configured.", + "type": "array", + "items": { + "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + }, + "readOnly": true + } + } + }, + "FileEventTrigger": { + "description": "Trigger details.", + "required": [ "properties", "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Trigger" } ], + "properties": { + "properties": { + "$ref": "#/definitions/FileTriggerProperties", + "description": "File trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "FileEvent" + }, + "FileSourceInfo": { + "description": "File source details.", + "required": [ "shareId" ], + "type": "object", + "properties": { + "shareId": { + "description": "File share ID.", + "type": "string" + } + } + }, + "FileTriggerProperties": { + "description": "File Trigger properties.", + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/FileSourceInfo", + "description": "File event source details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role Sink info." + }, + "customContextTag": { + "description": "Custom context tag, typically used to co-relate the trigger against its usage. Eg. If a PeriodicTimer trigger may be intended for certain specific IOT modules in device, the tag can be the name/image url of the module.", + "type": "string" + } + } + }, + "IoTDeviceInfo": { + "description": "Metadata of IoT device/IoT edge device to be configured.", + "required": [ "deviceId", "ioTHostHub" ], + "type": "object", + "properties": { + "deviceId": { + "description": "Id of the IoT device/edge device.", + "type": "string" + }, + "ioTHostHub": { + "description": "Host name for IoT hub which is associated to the device.", + "type": "string" + }, + "authentication": { + "$ref": "#/definitions/Authentication", + "description": "IoT device authentication info." + } + } + }, + "IoTRole": { + "description": "Compute role.", + "required": [ "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Role" } ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTRoleProperties", + "description": "Properties specific to IoT Role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "IOT" + }, + "IoTRoleProperties": { + "description": "IoT role properties.", + "required": [ "hostPlatform", "ioTDeviceDetails", "ioTEdgeDeviceDetails", "roleStatus" ], + "type": "object", + "properties": { + "hostPlatform": { + "description": "Host OS which IoT role support.", + "enum": [ "Windows", "Linux" ], + "type": "string", + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "ioTDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT device metadata to which data box edge device needs to be connected." + }, + "ioTEdgeDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT edge device to which the IoT role needs to be configured." + }, + "shareMappings": { + "description": "Mount points of shares in role(s).", + "type": "array", + "items": { "$ref": "#/definitions/MountPointMap" } + }, + "roleStatus": { + "description": "Role status.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "Ipv4Config": { + "description": "Details related to the IPv4 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv4 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "subnet": { + "description": "The IPv4 subnet of the network adapter.", + "type": "string", + "readOnly": true + }, + "gateway": { + "description": "The IPv4 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Ipv6Config": { + "description": "Details related to the IPv6 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv6 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "prefixLength": { + "format": "int32", + "description": "The IPv6 prefix of the network adapter.", + "type": "integer", + "readOnly": true + }, + "gateway": { + "description": "The IPv6 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Job": { + "description": "A device job.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of the job.", + "enum": [ "Invalid", "Running", "Succeeded", "Failed", "Canceled", "Paused", "Scheduled" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "The UTC datetime at which the job was started.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The UTC datetime at which the job completed.", + "type": "string", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "The percentage of the job that is already complete.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/JobErrorDetails", + "description": "The Error details.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The properties of the job.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "JobErrorDetails": { + "description": "The job error information containing List of JobErrorItem.", + "type": "object", + "properties": { + "errorDetails": { + "description": "The error details.", + "type": "array", + "items": { "$ref": "#/definitions/JobErrorItem" }, + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message intended to describe the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobErrorItem": { + "description": "The job error items.", + "type": "object", + "properties": { + "recommendations": { + "description": "The recommended actions.", + "type": "array", + "items": { "type": "string" }, + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message intended to describe the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobProperties": { + "description": "The properties for the job.", + "type": "object", + "properties": { + "jobType": { + "description": "The type of the job.", + "enum": [ "Invalid", "ScanForUpdates", "DownloadUpdates", "InstallUpdates", "RefreshShare" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "currentStage": { + "description": "Current stage of the update operation.", + "enum": [ "Unknown", "Initial", "ScanStarted", "ScanComplete", "ScanFailed", "DownloadStarted", "DownloadComplete", "DownloadFailed", "InstallStarted", "InstallComplete", "InstallFailed", "RebootInitiated", "Success", "Failure", "RescanStarted", "RescanComplete", "RescanFailed" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperationStage", + "modelAsString": true + } + }, + "downloadProgress": { + "$ref": "#/definitions/UpdateDownloadProgress", + "description": "The download progress.", + "readOnly": true + }, + "installProgress": { + "$ref": "#/definitions/UpdateInstallProgress", + "description": "The install progress.", + "readOnly": true + }, + "totalRefreshErrors": { + "format": "int32", + "description": "Total number of errors encountered during the refresh process.", + "type": "integer", + "readOnly": true + }, + "errorManifestFile": { + "description": "Local Share/Remote Container relative path to the error manifest file of the refresh.", + "type": "string", + "readOnly": true + }, + "shareId": { + "description": "ARM id of the Share on which the Refresh operation was done.", + "type": "string", + "readOnly": true + }, + "folder": { + "description": "If only subfolders need to be refreshed, then the sub folder path inside the share. Empty otherwise.", + "type": "string" + } + } + }, + "MetricDimension_V1": { + "description": "Metric Dimension v1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metrics dimension.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metrics dimension.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "To be exported to shoe box.", + "type": "boolean" + } + } + }, + "MetricSpecification_V1": { + "description": "Metric specification version 1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Description of the metric to be displayed.", + "type": "string" + }, + "unit": { + "description": "Metric units.", + "enum": [ "NotSpecified", "Percent", "Count", "Seconds", "Milliseconds", "Bytes", "BytesPerSecond", "CountPerSecond" ], + "type": "string", + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + }, + "aggregationType": { + "description": "Metric aggregation type.", + "enum": [ "NotSpecified", "None", "Average", "Minimum", "Maximum", "Total", "Count" ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + }, + "dimensions": { + "description": "Metric dimensions, other than default dimension which is resource.", + "type": "array", + "items": { "$ref": "#/definitions/MetricDimension_V1" } + }, + "fillGapWithZero": { + "description": "set true to fill the gaps with zero.", + "type": "boolean" + }, + "category": { + "description": "Metric category.", + "enum": [ "Capacity", "Transaction" ], + "type": "string", + "x-ms-enum": { + "name": "MetricCategory", + "modelAsString": true + } + }, + "resourceIdDimensionNameOverride": { + "description": "Resource name override.", + "type": "string" + }, + "supportedTimeGrainTypes": { + "description": "Support granularity of metrics.", + "type": "array", + "items": { + "enum": [ "PT1M", "PT5M", "PT15M", "PT30M", "PT1H", "PT6H", "PT12H", "PT1D" ], + "type": "string", + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true + } + } + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "type": "array", + "items": { + "enum": [ "NotSpecified", "None", "Average", "Minimum", "Maximum", "Total", "Count" ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + } + } + }, + "MountPointMap": { + "description": "The share mount point.", + "required": [ "shareId" ], + "type": "object", + "properties": { + "shareId": { + "description": "ID of the share which is mounted to role VM.", + "type": "string" + }, + "roleId": { + "description": "ID of the role to which share is mounted.", + "type": "string", + "readOnly": true + }, + "mountPoint": { + "description": "Mount point for the share.", + "type": "string", + "readOnly": true + }, + "roleType": { + "description": "Role type.", + "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + } + } + }, + "NetworkAdapter": { + "description": "Represents the networkAdapter on a device.", + "type": "object", + "properties": { + "adapterId": { + "description": "Instance ID of network adapter.", + "type": "string", + "readOnly": true + }, + "adapterPosition": { + "$ref": "#/definitions/NetworkAdapterPosition", + "description": "Hardware position of network adapter.", + "readOnly": true + }, + "index": { + "format": "int32", + "description": "Logical index of the adapter.", + "type": "integer", + "readOnly": true + }, + "nodeId": { + "description": "Node ID of the network adapter.", + "type": "string", + "readOnly": true + }, + "networkAdapterName": { + "description": "Network Adapter Name.", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Hardware label for the adapter.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "MAC Address.", + "type": "string", + "readOnly": true + }, + "linkSpeed": { + "format": "int64", + "description": "Link Speed.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "Value indicating whether this adapter is valid.", + "enum": [ "Inactive", "Active" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkAdapterStatus", + "modelAsString": true + } + }, + "rdmaStatus": { + "description": "Value indicating whether this adapter is RDMA Capable.", + "enum": [ "Incapable", "Capable" ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterRDMAStatus", + "modelAsString": true + } + }, + "dhcpStatus": { + "description": "Value indicating whether this adapter has DHCP Enabled.", + "enum": [ "Disabled", "Enabled" ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterDHCPStatus", + "modelAsString": true + } + }, + "ipv4Configuration": { + "$ref": "#/definitions/Ipv4Config", + "description": "The IPv4 configuration of the network adapter.", + "readOnly": true + }, + "ipv6Configuration": { + "$ref": "#/definitions/Ipv6Config", + "description": "The IPv6 configuration of the network adapter.", + "readOnly": true + }, + "ipv6LinkLocalAddress": { + "description": "The IPv6 local address.", + "type": "string", + "readOnly": true + }, + "dnsServers": { + "description": "The list DNS Servers of the device.", + "type": "array", + "items": { "type": "string" }, + "readOnly": true + } + } + }, + "NetworkAdapterPosition": { + "description": "The network adapter position.", + "type": "object", + "properties": { + "networkGroup": { + "description": "The network group.", + "enum": [ "None", "NonRDMA", "RDMA" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkGroup", + "modelAsString": true + } + }, + "port": { + "format": "int32", + "description": "The port.", + "type": "integer", + "readOnly": true + } + } + }, + "NetworkSettings": { + "description": "The NetworkSettings of a device.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSettingsProperties", + "description": "The properties of network settings of a device.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "NetworkSettingsProperties": { + "description": "The properties of NetworkSettings.", + "type": "object", + "properties": { + "networkAdapters": { + "description": "The network adapter list on the device.", + "type": "array", + "items": { "$ref": "#/definitions/NetworkAdapter" }, + "readOnly": true + } + } + }, + "Operation": { + "description": "Operations.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Properties to displayed for the operation." + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "Operation display properties.", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "The type of resource in which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation to be performed on the resource.", + "type": "string" + }, + "description": { + "description": "Description of the operation to be performed.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operations Properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specification." + } + } + }, + "OperationsList": { + "description": "Class for set of operations used for discovery of available provider operations.", + "required": [ "value" ], + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { "$ref": "#/definitions/Operation" } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string" + } + } + }, + "Order": { + "description": "The order details.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/OrderProperties", + "description": "The order properties.", + "x-ms-client-flatten": true + } + } + }, + "OrderList": { + "description": "List of order entities.", + "type": "object", + "properties": { + "value": { + "description": "The list of orders.", + "type": "array", + "items": { "$ref": "#/definitions/Order" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "OrderProperties": { + "description": "Order Properties.", + "type": "object", + "properties": { + "contactInformation": { + "$ref": "#/definitions/ContactDetails", + "description": "The contact details." + }, + "shippingAddress": { + "$ref": "#/definitions/Address", + "description": "The shipping address." + }, + "changeStatusTo": { + "$ref": "#/definitions/OrderStatus", + "description": "Current status of the Order." + }, + "orderHistory": { + "description": "List of status changes in the order.", + "type": "array", + "items": { "$ref": "#/definitions/OrderStatus" }, + "readOnly": true + }, + "serialNumber": { + "description": "Serial number of the device.", + "type": "string", + "readOnly": true + }, + "deliveryTrackingInfo": { + "description": "Tracking information related to the packages being delivered to the customer whether original or replacement devices.", + "type": "array", + "items": { "$ref": "#/definitions/TrackingInfo" }, + "readOnly": true + }, + "returnTrackingInfo": { + "description": "Tracking information related to the package being returned from the customer whether original or replacement devices.", + "type": "array", + "items": { "$ref": "#/definitions/TrackingInfo" }, + "readOnly": true + } + } + }, + "OrderStatus": { + "description": "Represents a single status change.", + "required": [ "status" ], + "type": "object", + "properties": { + "status": { + "description": "Status of the order pertaining to the allowed StatusTypes.", + "enum": [ "Untracked", "AwaitingFulfilment", "AwaitingPreparation", "AwaitingShipment", "Shipped", "Arriving", "Delivered", "ReplacementRequested", "LostDevice", "Declined", "ReturnInitiated", "AwaitingReturnShipment", "ShippedBack", "CollectedAtMicrosoft" ], + "type": "string", + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true + } + }, + "updateDateTime": { + "format": "date-time", + "description": "Time of status update.", + "type": "string", + "readOnly": true + }, + "comments": { + "description": "Comments related to this status change.", + "type": "string" + } + } + }, + "PeriodicTimerEventTrigger": { + "description": "Trigger details.", + "required": [ "properties", "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Trigger" } ], + "properties": { + "properties": { + "$ref": "#/definitions/PeriodicTimerProperties", + "description": "Periodic timer trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "PeriodicTimerEvent" + }, + "PeriodicTimerProperties": { + "description": "Periodic Timer Trigger properties.", + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/PeriodicTimerSourceInfo", + "description": "Periodic timer details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role Sink info." + }, + "customContextTag": { + "description": "Custom context tag, typically used to co-relate the trigger against its usage. Eg. If a PeriodicTimer trigger may be intended for certain specific IOT modules in device, the tag can be the name/image url of the module.", + "type": "string" + } + } + }, + "PeriodicTimerSourceInfo": { + "description": "Periodic timer event source.", + "required": [ "startTime", "schedule" ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Time time [UTC] of the day, from which the trigger will be valid. Schedule will be computed with reference to the time specified.", + "type": "string" + }, + "schedule": { + "description": "Periodic frequency at which timer event needs to be raised. Supports Daily, Hourly, Minutes and seconds.", + "type": "string" + }, + "topic": { + "description": "Topic with which periodic events needs to be published to IOT device.", + "type": "string" + } + } + }, + "RawCertificateData": { + "description": "Raw Certificate Data.", + "required": [ "certificate" ], + "type": "object", + "properties": { + "authenticationType": { + "description": "The authentication type.", + "enum": [ "Invalid", "AzureActiveDirectory" ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "certificate": { + "description": "The base64 encoded certificate raw data.", + "type": "string" + } + } + }, + "RefreshDetails": { + "description": "Fields for tracking refresh job on the share.", + "type": "object", + "properties": { + "inProgressRefreshJobId": { + "description": "If a RefreshShare job is currently inprogress on this share - this field indicates the ArmId of that job. Empty otherwise.", + "type": "string" + }, + "lastCompletedRefreshJobTimeInUTC": { + "format": "date-time", + "description": "Indicates the job completed time of the last refresh job on this particular share, if any.\r\nThis could be a failed job or a successful job.", + "type": "string" + }, + "errorManifestFile": { + "description": "Indicates the relative path of the error xml for the last refresh job on this particular share, if any.\r\nThis could be a failed job or a successful job.", + "type": "string" + }, + "lastJob": { + "description": "Indicates the id of the last refresh job on this particular share,if any.\r\nThis could be a failed job or a successful job.", + "type": "string" + } + } + }, + "Role": { + "description": "Compute role.", + "required": [ "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "kind": { + "description": "Role type.", + "enum": [ "IOT", "ASA", "Functions", "Cognitive" ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "RoleList": { + "description": "Collection of all role on the data box edge device.", + "type": "object", + "properties": { + "value": { + "description": "The Value.", + "type": "array", + "items": { "$ref": "#/definitions/Role" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "RoleSinkInfo": { + "description": "Compute role against which events will be raised.", + "required": [ "roleId" ], + "type": "object", + "properties": { + "roleId": { + "description": "Compute role ID.", + "type": "string" + } + } + }, + "SecuritySettings": { + "description": "The security settings of a device.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/SecuritySettingsProperties", + "description": "Properties of the security settings.", + "x-ms-client-flatten": true + } + } + }, + "SecuritySettingsProperties": { + "description": "The properties of security settings.", + "required": [ "deviceAdminPassword" ], + "type": "object", + "properties": { + "deviceAdminPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to log into the local web UI of the device. Actual password could have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters." + } + } + }, + "ServiceSpecification": { + "description": "Service specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Metric specification as defined by shoebox.", + "type": "array", + "items": { "$ref": "#/definitions/MetricSpecification_V1" } + } + } + }, + "Share": { + "description": "Represents a share on the Data Box Edge/Gateway device.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ShareProperties", + "description": "The share properties.", + "x-ms-client-flatten": true + } + } + }, + "ShareAccessRight": { + "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.", + "required": [ "shareId", "accessType" ], + "type": "object", + "properties": { + "shareId": { + "description": "Id of the share.", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed on the share for this user.", + "enum": [ "Change", "Read", "Custom" ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "ShareList": { + "description": "Collection of all shares on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of shares.", + "type": "array", + "items": { "$ref": "#/definitions/Share" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ShareProperties": { + "description": "The share properties.", + "required": [ "shareStatus", "monitoringStatus", "accessProtocol" ], + "type": "object", + "properties": { + "description": { + "description": "Description for the share.", + "type": "string" + }, + "shareStatus": { + "description": "Current status of the share.", + "enum": [ "Online", "Offline" ], + "type": "string", + "x-ms-enum": { + "name": "ShareStatus", + "modelAsString": true + } + }, + "monitoringStatus": { + "description": "Current monitoring status of the share.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true + } + }, + "azureContainerInfo": { + "$ref": "#/definitions/AzureContainerInfo", + "description": "Azure container mapping for the share." + }, + "accessProtocol": { + "description": "Access protocol to be used by the share.", + "enum": [ "SMB", "NFS" ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessProtocol", + "modelAsString": true + } + }, + "userAccessRights": { + "description": "Mapping of Users and corresponding access rights on the share (mandatory for SMB protocol).", + "type": "array", + "items": { "$ref": "#/definitions/UserAccessRight" } + }, + "clientAccessRights": { + "description": "List of IP addresses and corresponding access rights on the share(mandatory for NFS protocol).", + "type": "array", + "items": { "$ref": "#/definitions/ClientAccessRight" } + }, + "refreshDetails": { + "$ref": "#/definitions/RefreshDetails", + "description": "Details of the refresh job on this share." + }, + "shareMappings": { + "description": "Share mount point to the role.", + "type": "array", + "items": { "$ref": "#/definitions/MountPointMap" }, + "readOnly": true + }, + "dataPolicy": { + "description": "Data policy of the share.", + "enum": [ "Cloud", "Local" ], + "type": "string", + "x-ms-enum": { + "name": "DataPolicy", + "modelAsString": true + } + } + } + }, + "Sku": { + "description": "The SKU type.", + "type": "object", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ "Gateway", "Edge" ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The SKU tier. This is based on the SKU name.", + "enum": [ "Standard" ], + "type": "string", + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + } + }, + "StorageAccountCredential": { + "description": "The storage account credential.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountCredentialProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + } + } + }, + "StorageAccountCredentialList": { + "description": "The collection of storage account credential entities.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { "$ref": "#/definitions/StorageAccountCredential" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountCredentialProperties": { + "description": "The storage account credential properties.", + "required": [ "alias", "sslStatus", "accountType" ], + "type": "object", + "properties": { + "alias": { + "description": "Alias for the storage account.", + "type": "string" + }, + "userName": { + "description": "UserName for the storage account.", + "type": "string" + }, + "accountKey": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Encrypted storage key." + }, + "connectionString": { + "description": "ConnectionString for the storage account. This needs to be specified if UserName/AccountKey are not specified.", + "type": "string" + }, + "sslStatus": { + "description": "Signifies whether SSL needs to be enabled or not.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "SSLStatus", + "modelAsString": true + } + }, + "blobDomainName": { + "description": "Blob end point for private clouds.", + "type": "string" + }, + "accountType": { + "description": "Type of storage accessed on the storage account.", + "enum": [ "GeneralPurposeStorage", "BlobStorage" ], + "type": "string", + "x-ms-enum": { + "name": "AccountType", + "modelAsString": true + } + } + } + }, + "SymmetricKey": { + "description": "Symmetric Key for authentication.", + "type": "object", + "properties": { + "connectionString": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Connection string based on symmetric key." + } + } + }, + "TrackingInfo": { + "description": "Tracking courier information.", + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the device being tracked.", + "type": "string" + }, + "carrierName": { + "description": "Name of the carrier used in the delivery.", + "type": "string" + }, + "trackingId": { + "description": "Tracking ID of the shipment.", + "type": "string" + }, + "trackingUrl": { + "description": "Tracking URL of the shipment.", + "type": "string" + } + } + }, + "Trigger": { + "description": "Trigger details.", + "required": [ "kind" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "kind": { + "description": "Trigger Kind.", + "enum": [ "FileEvent", "PeriodicTimerEvent" ], + "type": "string", + "x-ms-enum": { + "name": "TriggerEventType", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "TriggerList": { + "description": "Collection of all trigger on the data box edge device.", + "type": "object", + "properties": { + "value": { + "description": "The list of triggers.", + "type": "array", + "items": { "$ref": "#/definitions/Trigger" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateDownloadProgress": { + "description": "Details about the download progress of update.", + "type": "object", + "properties": { + "downloadPhase": { + "description": "The download phase.", + "enum": [ "Unknown", "Initializing", "Downloading", "Verifying" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DownloadPhase", + "modelAsString": true + } + }, + "percentComplete": { + "format": "int32", + "description": "Percentage of completion.", + "type": "integer", + "readOnly": true + }, + "totalBytesToDownload": { + "format": "double", + "description": "Total bytes to download.", + "type": "number", + "readOnly": true + }, + "totalBytesDownloaded": { + "format": "double", + "description": "Total bytes downloaded.", + "type": "number", + "readOnly": true + }, + "numberOfUpdatesToDownload": { + "format": "int32", + "description": "Number of updates to download.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesDownloaded": { + "format": "int32", + "description": "Number of updates downloaded.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateInstallProgress": { + "description": "Details about the progress during installation of updates.", + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Percentage of completion.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesToInstall": { + "format": "int32", + "description": "Number of updates to install.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesInstalled": { + "format": "int32", + "description": "Number of updates installed.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateSummary": { + "description": "Details about ongoing updates and availability of updates on the device.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UpdateSummaryProperties", + "description": "The device update information summary.", + "x-ms-client-flatten": true + } + } + }, + "UpdateSummaryProperties": { + "description": "The device update information summary.", + "type": "object", + "properties": { + "deviceVersionNumber": { + "description": "The current version of the device, of format: 1.2.17312.13.", + "type": "string" + }, + "friendlyDeviceVersionName": { + "description": "The current version of the device represented in text format.", + "type": "string" + }, + "deviceLastScannedDateTime": { + "format": "date-time", + "description": "The last time when a scan was done on the device.", + "type": "string" + }, + "lastCompletedScanJobDateTime": { + "format": "date-time", + "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.", + "type": "string" + }, + "lastCompletedDownloadJobDateTime": { + "format": "date-time", + "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "lastCompletedInstallJobDateTime": { + "format": "date-time", + "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "totalNumberOfUpdatesAvailable": { + "format": "int32", + "description": "Count of updates that are available for the current device version as per the last scan on the device.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingDownload": { + "format": "int32", + "description": "The total number of items pending download.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingInstall": { + "format": "int32", + "description": "The total number of items pending install.", + "type": "integer", + "readOnly": true + }, + "rebootBehavior": { + "description": "Indicates if updates are available and at least one of the update items detected needs a reboot.", + "enum": [ "NeverReboots", "RequiresReboot", "RequestReboot" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InstallRebootBehavior", + "modelAsString": true + } + }, + "ongoingUpdateOperation": { + "description": "The current update operation.", + "enum": [ "None", "Scan", "Download", "Install" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperation", + "modelAsString": true + } + }, + "inProgressDownloadJobId": { + "description": "The Job ID of the download job if a download is in progress.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobId": { + "description": "The Job ID of the install job if an install is in progress.", + "type": "string", + "readOnly": true + }, + "inProgressDownloadJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running download (if any) started.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running install (if any) started.", + "type": "string", + "readOnly": true + }, + "updateTitles": { + "description": "The list of update titles which are available for install.", + "type": "array", + "items": { "type": "string" }, + "readOnly": true + }, + "totalUpdateSizeInBytes": { + "format": "double", + "description": "The total size of updates available for download in bytes.", + "type": "number", + "readOnly": true + } + } + }, + "UploadCertificateRequest": { + "description": "The Upload certificate request.", + "required": [ "properties" ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData", + "description": "The Base 64 encoded certificate raw data.", + "x-ms-client-flatten": true + } + } + }, + "UploadCertificateResponse": { + "description": "The upload registration certificate response.", + "required": [ "resourceId", "aadAuthority", "aadTenantId", "servicePrincipalClientId", "servicePrincipalObjectId", "azureManagementEndpointAudience" ], + "type": "object", + "properties": { + "authType": { + "description": "Specifies the Authentication type.", + "enum": [ "Invalid", "AzureActiveDirectory" ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "resourceId": { + "description": "The resource ID of the edge device.", + "type": "string" + }, + "aadAuthority": { + "description": "Azure Active Directory tenant authority.", + "type": "string" + }, + "aadTenantId": { + "description": "Azure Active Directory tenant ID.", + "type": "string" + }, + "servicePrincipalClientId": { + "description": "Azure Active Directory service principal client ID.", + "type": "string" + }, + "servicePrincipalObjectId": { + "description": "Azure Active Directory service principal Object ID.", + "type": "string" + }, + "azureManagementEndpointAudience": { + "description": "The Azure Management Endpoint Audience.", + "type": "string" + } + } + }, + "User": { + "description": "Represents a user who has access to one or more shares on the Edge storage device.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/ARMBaseModel" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + } + } + }, + "UserAccessRight": { + "description": "The mapping between a particular user and the type of access they have on the SMB share.", + "required": [ "userId", "accessType" ], + "type": "object", + "properties": { + "userId": { + "description": "Id of the user (already existing in the device).", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed for the user.", + "enum": [ "Change", "Read", "Custom" ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "UserList": { + "description": "Collection of users.", + "type": "object", + "properties": { + "value": { + "description": "The list of users.", + "type": "array", + "items": { "$ref": "#/definitions/User" }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UserProperties": { + "description": "The User properties.", + "type": "object", + "properties": { + "encryptedPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "The details of the password specified for the user." + }, + "shareAccessRights": { + "description": "List of shares that the user has rights on. This field should not be specified during user creation.", + "type": "array", + "items": { "$ref": "#/definitions/ShareAccessRight" } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version.", + "required": true, + "type": "string" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "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/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGet.json new file mode 100644 index 000000000000..0b614e17f97d --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGetAllInDevice.json new file mode 100644 index 000000000000..ae659e83af59 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/AlertGetAllInDevice.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "title": "Device password has changed", + "alertType": "PasswordChangedEvent", + "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z", + "recommendation": "The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required.", + "severity": "Informational", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 2 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790", + "name": "83eccd0b-134b-40b0-ad62-b5f124d03790", + "type": "dataBoxEdgeDevices/alerts" + }, + { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleDelete.json new file mode 100644 index 000000000000..3624f97deb1b --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGet.json new file mode 100644 index 000000000000..9d0df9800de0 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGetAllInDevice.json new file mode 100644 index 000000000000..e65175193018 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthScheduleGetAllInDevice.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthSchedulePut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthSchedulePut.json new file mode 100644 index 000000000000..9e9d8809d8e5 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/BandwidthSchedulePut.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "start": "0:0:0", + "stop": "13:59:0", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSettings" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceDelete.json new file mode 100644 index 000000000000..84ffc3af1604 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByName.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByName.json new file mode 100644 index 000000000000..a301c091b7ed --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByName.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-16T08%3A03%3A27.61Z'\"_W/\"datetime'2018-12-16T08%3A03%3A27.653Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json new file mode 100644 index 000000000000..a1f489b0c10b --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A06.493Z'\"_W/\"datetime'2018-12-17T10%3A31%3A06.597Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-09-27T09%3A45%3A09.15Z'\"_W/\"datetime'2018-09-27T09%3A45%3A09.177Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice2", + "name": "testedgedevice2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A00.293Z'\"_W/\"datetime'2018-12-17T10%3A31%3A00.34Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice3", + "name": "testedgedevice3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetBySubscription.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetBySubscription.json new file mode 100644 index 000000000000..a1fdb28f372a --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDeviceGetBySubscription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A06.493Z'\"_W/\"datetime'2018-12-17T10%3A31%3A06.597Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-09-27T09%3A45%3A09.15Z'\"_W/\"datetime'2018-09-27T09%3A45%3A09.177Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice2", + "name": "testedgedevice2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A00.293Z'\"_W/\"datetime'2018-12-17T10%3A31%3A00.34Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice3", + "name": "testedgedevice3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePatch.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePatch.json new file mode 100644 index 000000000000..4587d563f3cf --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePatch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "tags": { + "Key1": "value1", + "Key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": { + "Key1": "value1", + "Key2": "value2" + }, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2018-12-19T06%3A33%3A24.983Z'\"_W/\"datetime'2018-12-19T06%3A33%3A25.013Z'\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePut.json new file mode 100644 index 000000000000..0439922e6a5f --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DataBoxEdgeDevicePut.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "DataBoxEdgeDevice": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "standard" + }, + "name": "testedgedevice" + } + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "name": "testedgedevice" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DownloadUpdatesPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DownloadUpdatesPost.json new file mode 100644 index 000000000000..59e56b152f08 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/DownloadUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPost.json new file mode 100644 index 000000000000..645cfcaaec74 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPost.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "integrityKey": "Test-integrity-key", + "resourceKey": "3482840729935603111" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPut.json new file mode 100644 index 000000000000..a85597f42c7c --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ExtendedInfoPut.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "integrityKey": "Test-integrity-key" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "integrityKey": "Test-integrity-key", + "resourceKey": "3482840729935603111" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/InstallUpdatesPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/InstallUpdatesPost.json new file mode 100644 index 000000000000..59e56b152f08 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/InstallUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/NetworkSettingsGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/NetworkSettingsGet.json new file mode 100644 index 000000000000..26afdd045924 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/NetworkSettingsGet.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "networkAdapters": [ + { + "adapterId": "{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}", + "adapterPosition": { + "networkGroup": "NonRDMA", + "port": 0 + }, + "index": 1, + "nodeId": "3fd54d9e-f7a0-45bf-bdf1-39b0977d1984", + "networkAdapterName": "DATA1", + "label": "DATA1", + "macAddress": "00155D4E265B", + "linkSpeed": 10000000000, + "status": "Inactive", + "rdmaStatus": "Incapable", + "dhcpStatus": "Disabled", + "ipv4Configuration": { + "ipAddress": "10.150.78.56", + "subnet": "255.255.252.0", + "gateway": "10.150.76.1" + }, + "ipv6Configuration": { + "ipAddress": "2404:f801:4800:1e:d5c6:50a1:465b:1bbf", + "prefixLength": 64, + "gateway": "fe80::12f3:11ff:fe36:994b%5" + }, + "ipv6LinkLocalAddress": "fe80::d5c6:50a1:465b:1bbf%5", + "dnsServers": [ + "10.50.50.50", + "10.50.10.50" + ] + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsGet.json new file mode 100644 index 000000000000..fe7d62ef4210 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsGet.json @@ -0,0 +1,717 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Creates or updates share users", + "description": "Creates or updates the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Delete share users", + "description": "Deletes the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Creates or updates bandwidth schedules", + "description": "Creates or updates the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Delete bandwidth schedules", + "description": "Deletes the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Creates or updates ArmApiRes_roles", + "description": "Creates or updates the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Delete ArmApiRes_roles", + "description": "Deletes the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Creates or updates shares", + "description": "Creates or updates the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "ArmApiOp_action_refresh_shares", + "description": "ArmApiDesc_action_refresh_shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Delete shares", + "description": "Deletes the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Upload certificates", + "description": "Upload certificate for device registration" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Delete Data Box Edge devices", + "description": "Deletes the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices", + "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Gets resource extended information", + "description": "Retrieves resource extended information" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device network settings", + "operation": "List Device network settings", + "description": "Lists or gets the Device network settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device security settings", + "operation": "Update security settings", + "description": "Update security settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "update summary", + "operation": "List update summary", + "description": "Lists or gets the update summary" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Scan for updates", + "description": "Scan for updates" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Download Updates", + "description": "Download Updates in device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Install Updates", + "description": "Install Updates on device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "jobs", + "operation": "List jobs", + "description": "Lists or gets the jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Creates or updates storage account credentials", + "description": "Creates or updates the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Delete storage account credentials", + "description": "Deletes the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read Data Box Edge device metric definition", + "description": "Gets the available Data Box Edge device level metrics" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "NICReadThroughput", + "displayName": "Read Throughput (Network)", + "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "NICWriteThroughput", + "displayName": "Write Throughput (Network)", + "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughputPerShare", + "displayName": "Cloud Download Throughput (Share)", + "displayDescription": "The download throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughputPerShare", + "displayName": "Cloud Upload Throughput (Share)", + "displayDescription": "The upload throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloudPerShare", + "displayName": "Cloud Bytes Uploaded (Share)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "TotalCapacity", + "displayName": "Total Capacity", + "displayDescription": "Total Capacity", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "AvailableCapacity", + "displayName": "Available Capacity", + "displayDescription": "The available capacity in bytes during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughput", + "displayName": "Cloud Upload Throughput", + "displayDescription": "The cloud upload throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughput", + "displayName": "Cloud Read Throughput", + "displayDescription": "The cloud download throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloud", + "displayName": "Cloud Bytes Uploaded (Device)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + } + ] + } + } + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Write diagnostics setting", + "description": "Creates or updates the diagnostics setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read", + + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read diagnostics setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsStatusGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsStatusGet.json new file mode 100644 index 000000000000..2f687b673c06 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OperationsStatusGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "status": "Succeeded", + "startTime": "2018-12-18T02:18:51.4270267Z", + "endTime": "2018-12-18T03:18:51.4270267Z", + "percentComplete": 100, + "properties": { + "jobType": "DownloadUpdates", + "currentStage": "Success" + } + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderDelete.json new file mode 100644 index 000000000000..f88586a70ec2 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGet.json new file mode 100644 index 000000000000..ae14cce37fdb --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGet.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "changeStatusTo": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [ + { + "serialNumber": "UDS123NSDA123", + "carrierName": "UPS", + "trackingId": "1231323111", + "trackingUrl": "contoso.com" + } + ], + "returnTrackingInfo": [ + { + "serialNumber": "UDS123NSDA123", + "carrierName": "UPS", + "trackingId": "1231323111", + "trackingUrl": "contoso.com" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGetAllInDevice.json new file mode 100644 index 000000000000..b9737e6ca36b --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderGetAllInDevice.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "changeStatusTo": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [ + { + "serialNumber": "UDS123NSDA123", + "carrierName": "UPS", + "trackingId": "1231323111", + "trackingUrl": "contoso.com" + } + ], + "returnTrackingInfo": [ + { + "serialNumber": "UDS123NSDA123", + "carrierName": "UPS", + "trackingId": "1231323111", + "trackingUrl": "contoso.com" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderPut.json new file mode 100644 index 000000000000..55291d6a41c2 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/OrderPut.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "order": { + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "changeStatusTo": { + "status": "Untracked", + "comments": "Send the parcel to this address" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "changeStatusTo": { + "status": "Untracked", + "comments": "Send the parcel to this address" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleDelete.json new file mode 100644 index 000000000000..540c9accd335 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": "" + }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGet.json new file mode 100644 index 000000000000..899fed7862f7 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGetAllInDevice.json new file mode 100644 index 000000000000..8c88cc0ed298 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RoleGetAllInDevice.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RolePut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RolePut.json new file mode 100644 index 000000000000..618c97313a47 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/RolePut.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "role": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "348586569999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "1245475856069999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "shareMappings": [ + ], + + "roleStatus": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/Roles/IoTRole1", + "name": "IoTRole3", + "type": "dataBoxEdgeDevices/roles" + } + }, + "responses": { + "200": { + "body": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACDelete.json new file mode 100644 index 000000000000..761907831c81 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGet.json new file mode 100644 index 000000000000..b5abe7d74f59 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGetAllInDevice.json new file mode 100644 index 000000000000..031d95442dee --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACGetAllInDevice.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "alias": "sac1128180128323", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "GeneralPurposeStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323", + "name": "sac1128180128323", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + { + "properties": { + "alias": "sac1128180128312", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312", + "name": "sac1128180128312", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACPut.json new file mode 100644 index 000000000000..a7125f57241b --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SACPut.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "storageAccountCredential": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "accountKey": { + "value": "lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA==", + "encryptionCertThumbprint": "2A9D8D6BE51574B5461230AEF02F162C5F01AD31", + "encryptionAlgorithm": "AES256" + }, + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "name": "sac1" + } + }, + "responses": { + "200": { + "body": + { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ScanForUpdatesPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ScanForUpdatesPost.json new file mode 100644 index 000000000000..59e56b152f08 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ScanForUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SecuritySettingsUpdatePost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SecuritySettingsUpdatePost.json new file mode 100644 index 000000000000..d76e454df190 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SecuritySettingsUpdatePost.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "AzureVM", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "securitySettings": { + "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/AzureVM/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/securitySettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings", + "properties": { + "deviceAdminPassword": { + "value": "jJ5MvXa/AEWvwxviS92uCjatCXeyLYTy8jx/k105MjQRXT7i6Do8qpEcQ8d+OBbwmQTnwKW0CYyzzVRCc0uZcPCf6PsWtP4l6wvcKGAP66PwK68eEkTUOmp+wUHc4hk02kWmTWeAjBZkuDBP3xK1RnZo95g2RE4i1UgKNP5BEKCLd71O104DW3AWW41mh9XLWNOaxw+VjQY7wmvlE6XkvpkMhcGuha2u7lx8zi9ZkcMvJVYDYK36Fb/K3KhBAmDjjDmVq04jtBlcSTXQObt0nlj4BwGGtdrpeIpr67zqr5i3cPm6e6AleIaIhp6sI/uyGSMiT3oev2eg49u2ii7kVA==", + "encryptionAlgorithm": "AES256", + "encryptionCertThumbprint": "7DCBDFC44ED968D232C9A998FC105B5C70E84BE0" + } + } + } + }, + "responses": { + "202": { "body": "" }, + "204": { } + + } +} diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareDelete.json new file mode 100644 index 000000000000..2dbe4e980cc9 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "testShare1234SMB", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGet.json new file mode 100644 index 000000000000..0e45ac2d19c2 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "testShare1234SMB", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB", + "name": "testShare1234SMB", + "type": "dataBoxEdgeDevices/shares" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGetAllInDevice.json new file mode 100644 index 000000000000..802fe2e6f800 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareGetAllInDevice.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB", + "name": "testShare1234SMB", + "type": "dataBoxEdgeDevices/shares" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SharePut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SharePut.json new file mode 100644 index 000000000000..663e9e617aa3 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/SharePut.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "testShare1234SMB", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "share": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Enabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "dataPolicy": "Cloud" + }, + "name": "testShare1234SMB" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-2FO5M5SFCEN1218180610041/storageAccountCredentials/sac1218180610052", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/testShare1234SMB", + "name": "testShare1234SMB", + "type": "dataBoxEdgeDevices/shares" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareRefreshPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareRefreshPost.json new file mode 100644 index 000000000000..133495d19895 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/ShareRefreshPost.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "testShare1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerDelete.json new file mode 100644 index 000000000000..0c5ef20cdbad --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGet.json new file mode 100644 index 000000000000..1f63ac18f6c6 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGetAllInDevice.json new file mode 100644 index 000000000000..b643c83f2f67 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerGetAllInDevice.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerPut.json new file mode 100644 index 000000000000..af6b32d9f129 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/TriggerPut.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "trigger": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryGet.json new file mode 100644 index 000000000000..4ad324d6beb7 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceVersionNumber": "1.2.18183.2", + "friendlyDeviceVersionName": "Data Box Edge Virtual Device Preview Version 1.1", + "totalNumberOfUpdatesAvailable": 0, + "totalNumberOfUpdatesPendingDownload": 0, + "totalNumberOfUpdatesPendingInstall": 0, + "rebootBehavior": "NeverReboots", + "ongoingUpdateOperation": "None", + "totalUpdateSizeInBytes": 0.0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryPost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryPost.json new file mode 100644 index 000000000000..5577c30bd205 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UpdateSummaryPost.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceVersionNumber": "1.2.18183.2", + "friendlyDeviceVersionName": "Data Box Edge Virtual Device Preview Version 1.1", + "totalNumberOfUpdatesAvailable": 0, + "totalNumberOfUpdatesPendingDownload": 0, + "totalNumberOfUpdatesPendingInstall": 0, + "rebootRequiredForInstall": false, + "ongoingUpdateOperation": "None", + "totalUpdateSizeInBytes": 0.0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UploadCertificatePost.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UploadCertificatePost.json new file mode 100644 index 000000000000..04217a281c56 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UploadCertificatePost.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "authType": "AzureActiveDirectory", + "resourceId": "392799901267771", + "aadAuthority": "https://login.windows.net", + "aadTenantId": "100b019d-4626-4a9e-a83c-9cff8fe41909", + "servicePrincipalClientId": "ffd8a688-82b1-4e5a-a4c1-7ede8c928e68", + "servicePrincipalObjectId": "cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4", + "azureManagementEndpointAudience": "https://wus-bvtgateway.ext.trafficmanager.net/" + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserDelete.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserDelete.json new file mode 100644 index 000000000000..47e2e2884ec8 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserDelete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { "body": "" }, + "202": { "body": "" }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGet.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGet.json new file mode 100644 index 000000000000..88ba17c06bea --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + "202": { "body": "" } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGetAllInDevice.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGetAllInDevice.json new file mode 100644 index 000000000000..32a31d565f94 --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserGetAllInDevice.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "name": "user2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + { + "properties": {}, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserPut.json b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserPut.json new file mode 100644 index 000000000000..27d3a1f40d4d --- /dev/null +++ b/specification/edgegateway/resource-manager/Microsoft.DataBoxEdge/stable/2018-07-01/examples/UserPut.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "user": { + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users", + "properties": { + "encryptedPassword": { + "value": "Password@1", + "encryptionAlgorithm": "None", + "EncryptionCertThumbprint": "blah" + }, + "shareAccessRights": [] + } + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + }, + "202": { "body": "" } + } +} \ No newline at end of file diff --git a/specification/edgegateway/resource-manager/readme.go.md b/specification/edgegateway/resource-manager/readme.go.md new file mode 100644 index 000000000000..5969ef05f9be --- /dev/null +++ b/specification/edgegateway/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: edgegateway + clear-output-folder: true +``` + +### Go multi-api + +```yaml $(go) && $(multiapi) +batch: + - tag: package-2018-07 +``` + +### Tag: package-2018-07 and go + +These settings apply only when `--tag=package-2018-07 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag) == 'package-2018-07' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-07-01/$(namespace) +``` diff --git a/specification/edgegateway/resource-manager/readme.md b/specification/edgegateway/resource-manager/readme.md new file mode 100644 index 000000000000..4a1fa69dbbff --- /dev/null +++ b/specification/edgegateway/resource-manager/readme.md @@ -0,0 +1,147 @@ +# 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 +tag: package-2018-07 +``` + +### Tag: package-2018-07 + +These settings apply only when `--tag=package-2018-07` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07' +input-file: +- Microsoft.DataBoxEdge/stable/2018-07-01/edgegateway.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-go + - repo: azure-sdk-for-java + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_edgegateway'] +``` + +## 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.EdgeGateway + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/EdgeGateway/Management.EdgeGateway/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.edgegateway + package-name: azure-mgmt-edgegateway + title: EdgeGatewayManagementClient + description: The EdgeGateway Client. + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-edgegateway/azure/mgmt/edgegateway +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-edgegateway +``` + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + fluent: true + namespace: com.microsoft.azure.management.edgegateway + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-edgegateway +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-07 +``` + +### Tag: package-2018-07 and java + +These settings apply only when `--tag=package-2018-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.edgegateway.v2018_07_01 + output-folder: $(azure-libraries-for-java-folder)/edgegateway/resource-manager/v2018_07_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/edgegateway/resource-manager/readme.nodejs.md b/specification/edgegateway/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..8d98dd22b64a --- /dev/null +++ b/specification/edgegateway/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 + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-arm-edgegateway + output-folder: $(node-sdks-folder)/lib/services/edgegatewayManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` diff --git a/specification/edgegateway/resource-manager/readme.ruby.md b/specification/edgegateway/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..2787a078d8a3 --- /dev/null +++ b/specification/edgegateway/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml $(ruby) +package-name: azure_mgmt_edgegateway +package-version: "0.0.1" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-07 +``` + +### Tag: package-2018-07 and ruby + +These settings apply only when `--tag=package-2018-07 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-07' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2018_07_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_edgegateway/lib +``` diff --git a/specification/edgegateway/resource-manager/readme.typescript.md b/specification/edgegateway/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..d7c26804f5b1 --- /dev/null +++ b/specification/edgegateway/resource-manager/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: "@azure/arm-edgegateway" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-edgegateway" + generate-metadata: true +``` diff --git a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json index 5e30c7fbdde9..9995610b7a2a 100644 --- a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json +++ b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json @@ -25,6 +25,24 @@ ], "properties": {} }, + "ContainerRegistryChartPushedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartPushed event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryArtifactEventData" + } + ], + "properties": {} + }, + "ContainerRegistryChartDeletedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.ContainerRegistry.ChartDeleted event.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryArtifactEventData" + } + ], + "properties": {} + }, "ContainerRegistryEventData": { "description": "The content of the event request message.", "properties": { @@ -59,6 +77,28 @@ } } }, + "ContainerRegistryArtifactEventData": { + "description": "The content of the event request message.", + "properties": { + "id": { + "description": "The event ID.", + "type": "string" + }, + "timestamp": { + "format": "date-time", + "description": "The time at which the event occurred.", + "type": "string" + }, + "action": { + "description": "The action that encompasses the provided event.", + "type": "string" + }, + "target": { + "$ref": "#/definitions/ContainerRegistryArtifactEventTarget", + "description": "The target of the event." + } + } + }, "ContainerRegistryEventTarget": { "description": "The target of the event.", "properties": { @@ -94,6 +134,40 @@ } } }, + "ContainerRegistryArtifactEventTarget": { + "description": "The target of the event.", + "properties": { + "mediaType": { + "description": "The MIME type of the artifact.", + "type": "string" + }, + "size": { + "format": "int64", + "description": "The size in bytes of the artifact.", + "type": "integer" + }, + "digest": { + "description": "The digest of the artifact.", + "type": "string" + }, + "repository": { + "description": "The repository name of the artifact.", + "type": "string" + }, + "tag": { + "description": "The tag of the artifact.", + "type": "string" + }, + "name": { + "description": "The name of the artifact.", + "type": "string" + }, + "version": { + "description": "The version of the artifact.", + "type": "string" + } + } + }, "ContainerRegistryEventRequest": { "description": "The request that generated the event.", "properties": { diff --git a/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/Maps.json b/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/Maps.json index e7f7ab02d8de..9b7b9bfd05b7 100644 --- a/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/Maps.json +++ b/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/Maps.json @@ -38,11 +38,11 @@ "type": "object", "description": "Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).", "properties": { - "details": { - "description": "List details generated during processing.", + "expiredGeofenceGeometryId": { + "description": "Lists of the geometry ID of the geofence which is expired relative to the user time in the request.", "type": "array", "items": { - "$ref": "#/definitions/MapsGeofenceDetail" + "type": "string" } }, "geometries": { @@ -51,6 +51,17 @@ "items": { "$ref" : "#/definitions/MapsGeofenceGeometry" } + }, + "invalidPeriodGeofenceGeometryId": { + "description": "Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.", + "type": "array", + "items": { + "type": "string" + } + }, + "isEventPublished": { + "description": "True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.", + "type": "boolean" } } }, @@ -58,68 +69,29 @@ "description": "The geofence geometry.", "type": "object", "properties": { - "udId": { - "description": "The unique ID returned from user upload service when uploading a geofence.", + "deviceId": { + "description": "ID of the device.", "type": "string" }, + "distance": { + "description": "Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.", + "type": "number" + }, "geometryId": { "description": "The unique ID for the geofence geometry.", "type": "string" }, - "distance": { - "description": "Distance from the coordinate to the closest border line of the polygon, point or point on the polyline. If the coordinate is outside, then the distance is positive. Negative means the coordinate is inside. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest polygon border line, point or polyline, then the value is -999. A value of -999 means that there is great confidence the coordinate is well within the geofence.", - "type": "number" - }, "nearestLat": { - "description": "Latitude of the nearest point of the geometry/geometry border. Void if distance = -999.", + "description": "Latitude of the nearest point of the geometry.", "type": "number" }, "nearestLon": { - "description": "Longitude of the nearest point of the geometry/geometry border. Void if distance = -999.", + "description": "Longitude of the nearest point of the geometry.", "type": "number" - } - } - }, - "MapsGeofenceDetail": { - "description": "Lists detail generated during processing.", - "type": "object", - "properties": { - "code": { - "description": "The detail code which identifies each detail item being returned.", - "type": "string", - "enum": [ - "ExpiredGeofencingData", - "GeofencingEventPublished", - "InvalidTimeGeofencingData" - ], - "x-ms-enum": { - "name": "MapsGeofenceDetailCodeType" - } }, - "message": { - "description": "Text description of the detail.", + "udId": { + "description": "The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.", "type": "string" - }, - "type": { - "description": "The type of the detail.", - "type": "string", - "enum": [ - "Information", - "Warning" - ], - "x-ms-enum": { - "name": "MapsGeofenceDetailType", - "values": [ - { - "value": "Information", - "description": "Useful information to inform clients." - }, - { - "value": "Warning", - "description": "The detail serves as a warning to client." - } - ] - } } } } 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 index a54eea59dffe..7b4e0fe4ce26 100644 --- 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 @@ -366,6 +366,29 @@ "type": "object", "description": "The event data for a Job output asset." }, + "MediaJobOutputProgressEventData": { + "x-ms-discriminator-value": "#Microsoft.Media.JobOutputProgress", + "description": "Job Output Progress Event Data.", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Gets the Job output label." + }, + "progress": { + "type": "integer", + "format": "int64", + "description": "Gets the Job output progress." + }, + "jobCorrelationData": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets the Job correlation data." + } + } + }, "MediaJobOutputStateChangeEventData": { "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputStateChange event.", "type": "object", diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json index 02619144dfc7..427c85902d5e 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/Storage.json @@ -33,7 +33,8 @@ }, "contentLength": { "description": "The size of the blob in bytes. This is the same as what would be returned in the Content-Length header from the blob.", - "type": "integer" + "type": "integer", + "format": "int64" }, "blobType": { "description": "The type of blob.", diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index 26b3e21bc010..732184217d71 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -52,6 +52,7 @@ input-file: - Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json - Microsoft.ServiceBus/stable/2018-01-01/ServiceBus.json - Microsoft.Media/stable/2018-01-01/MediaServices.json +- Microsoft.Maps/stable/2018-01-01/Maps.json ``` --- diff --git a/specification/eventgrid/resource-manager/readme.go.md b/specification/eventgrid/resource-manager/readme.go.md index 0c7f7516672f..43c4093c0602 100644 --- a/specification/eventgrid/resource-manager/readme.go.md +++ b/specification/eventgrid/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2019-01 - tag: package-2018-09-preview - tag: package-2018-05-preview - tag: package-2018-01 diff --git a/specification/eventgrid/resource-manager/readme.ruby.md b/specification/eventgrid/resource-manager/readme.ruby.md index 1b6ccfeb2fb4..0467e8ee3aa4 100644 --- a/specification/eventgrid/resource-manager/readme.ruby.md +++ b/specification/eventgrid/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2019-01 - tag: package-2018-09-preview - tag: package-2018-05-preview - tag: package-2018-01 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 21af98876a91..d3eb676181c1 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 @@ -2250,6 +2250,10 @@ "destination": { "$ref": "#/definitions/Destination", "description": "Properties of Destination where capture will be stored. (Storage Account, Blob Names)" + }, + "skipEmptyArchives": { + "type": "boolean", + "description": "A value that indicates whether to Skip Empty Archives" } }, "description": "Properties to configure capture description for eventhub" diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignmentReportById.json index a9370cb77451..f5fe2d993e59 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignmentReportById.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignmentReportById.json @@ -18,7 +18,8 @@ "assignment": { "name": "AuditSecureProtocol", "configuration": { - "name": "AuditSecureProtocol" + "name": "AuditSecureProtocol", + "version": "1.0.0.0" } }, "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json index 92ba26085102..b4e14515a421 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json @@ -743,13 +743,18 @@ "description": "Information about the VM." }, "ConfigurationInfo": { - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "Name of the configuration." - } - }, + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the configuration." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Version of the configuration." + } + }, "description": "Information about the configuration." }, "AssignmentReportDetails": { diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Get.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Get.json index ffa310f7e6a1..6a6264413150 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Get.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Get.json @@ -18,6 +18,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "restarting", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "Cisco_UCS", "hanaInstanceSize": "S72" 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 11c30cc0a736..6f579c8cdd94 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 @@ -18,6 +18,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "Cisco_UCS", "hanaInstanceSize": "S72" @@ -51,6 +52,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "HPE", "hanaInstanceSize": "S384" @@ -81,6 +83,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "HPE", "hanaInstanceSize": "S960m" @@ -111,6 +114,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "Cisco_UCS", "hanaInstanceSize": "S96" 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 816eb6e01f9a..a0d5491a849a 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 @@ -19,6 +19,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "Cisco_UCS", "hanaInstanceSize": "S72" @@ -52,6 +53,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "HPE", "hanaInstanceSize": "S384" diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags.json index b9fff0a699a8..7694ce32c9ea 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags.json @@ -21,6 +21,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "Cisco_UCS", "hanaInstanceSize": "S72" diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags_Delete.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags_Delete.json index 2c7fc4f5da13..4ca6e4a6b716 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags_Delete.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags_Delete.json @@ -19,6 +19,7 @@ "properties": { "hanaInstanceId": "00000000-0000-0000-0000-000000000000", "powerState": "started", + "proximityPlacementGroup": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", "hardwareProfile": { "hardwareType": "Cisco_UCS", "hanaInstanceSize": "S72" diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Restart.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Restart.json index 42409b5119ed..85a7087d0949 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Restart.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_Restart.json @@ -6,6 +6,7 @@ "hanaInstanceName": "myHanaInstance" }, "responses": { + "200": {}, "202": {} } } \ 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 561b7078ad3a..30a25c40332d 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 @@ -248,6 +248,7 @@ "HanaOnAzure" ], "operationId": "HanaInstances_Restart", + "x-ms-long-running-operation": true, "description": "The operation to restart a SAP HANA instance.", "x-ms-examples": { "Restart a HANA instance": { @@ -275,6 +276,9 @@ } ], "responses": { + "200": { + "description": "OK" + }, "202": { "description": "Accepted" } @@ -387,6 +391,11 @@ "modelAsString": true }, "description": "Resource power state" + }, + "proximityPlacementGroup": { + "readOnly": true, + "type": "string", + "description": "Resource proximity placement group" } }, "description": "Describes the properties of a HANA instance." 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 9c62de695cb5..96e83bd8c2cf 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 @@ -676,6 +676,14 @@ "key": { "type": "string", "description": "The storage account access key." + }, + "resourceId": { + "type": "string", + "description": "The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2." + }, + "msiResourceId": { + "type": "string", + "description": "The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2." } }, "description": "The storage Account." 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 index 772af1b8f092..61b0b7df3398 100644 --- 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 @@ -676,6 +676,14 @@ "key": { "type": "string", "description": "The storage account access key." + }, + "resourceId": { + "type": "string", + "description": "The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2." + }, + "msiResourceId": { + "type": "string", + "description": "The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2." } }, "description": "The storage Account." diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json index 7487dbf365a5..2a8609972583 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json @@ -2386,8 +2386,13 @@ "minimum": 10485760 }, "encoding": { - "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avrodeflate'. Default value is 'avro'.", - "type": "string" + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.", + "type": "string", + "enum": [ + "Avro", + "AvroDeflate", + "JSON" + ] } }, "required": [ diff --git a/specification/iothub/resource-manager/readme.go.md b/specification/iothub/resource-manager/readme.go.md index 3cc41c079f70..031dd62c43f0 100644 --- a/specification/iothub/resource-manager/readme.go.md +++ b/specification/iothub/resource-manager/readme.go.md @@ -26,7 +26,7 @@ These settings apply only when `--tag=package-2018-12-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-12-preview' && $(go) -output-folder: $(go-sdk-folder)/services/iothub/mgmt/2018-12-01-preview/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/iothub/mgmt/2018-12-01-preview/$(namespace) ``` ### Tag: package-2018-04 and go @@ -72,4 +72,4 @@ Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-09' && $(go) -output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2018-03-01/$(namespace) -``` - -### Tag: package-2017-08 and go - -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/preview/monitor/mgmt/2017-05-01-preview/$(namespace) ``` @@ -54,3 +45,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-11-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/monitor/mgmt/2018-11-01-preview/$(namespace) +``` diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 99c43d876c8e..6fe368f32359 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for MonitorClient. - - --- + ## Getting Started + To build the SDK for MonitorClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,23 +15,50 @@ To build the SDK for MonitorClient, simply [Install AutoRest](https://aka.ms/aut To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the MonitorClient API. ``` yaml title: MonitorClient description: Monitor Management Client openapi-type: arm +tag: package-2018-11-preview +``` -tag: package-2018-09 +### Tag: package-2018-11-preview +These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. + +```yaml $(tag) == 'package-2018-11-preview' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/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 +- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json ``` + ### Tag: package-2018-09 These settings apply only when `--tag=package-2018-09` is specified on the command line. @@ -85,7 +112,6 @@ input-file: - Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json ``` - ### Tag: package-2018-02-preview These settings apply only when `--tag=package-2018-02-preview` is specified on the command line. @@ -110,7 +136,6 @@ input-file: - Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json ``` - ### Tag: package-2017-12 These settings apply only when `--tag=package-2017-12` is specified on the command line. @@ -273,8 +298,8 @@ input-file: ``` --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -293,7 +318,6 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_monitor'] ``` - ## C# These settings apply only when `--csharp` is specified on the command line. diff --git a/specification/monitor/resource-manager/readme.python.md b/specification/monitor/resource-manager/readme.python.md index 04fa322fe2ce..f911c3f03204 100644 --- a/specification/monitor/resource-manager/readme.python.md +++ b/specification/monitor/resource-manager/readme.python.md @@ -12,7 +12,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.monitor package-name: azure-mgmt-monitor - package-version: 0.5.0 + package-version: 0.6.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerCreate.json index 9c1963d966a0..e97e970bbba5 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerCreate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerCreate.json @@ -18,10 +18,10 @@ "createMode": "Default" }, "sku": { - "name": "B_Gen4_2", + "name": "B_Gen5_2", "tier": "Basic", "capacity": 2, - "family": "Gen4" + "family": "Gen5" }, "tags": { "ElasticServer": "1" @@ -37,8 +37,8 @@ "location": "eastus", "sku": { "capacity": 2, - "family": "Gen4", - "name": "B_Gen4_2", + "family": "Gen5", + "name": "B_Gen5_2", "size": null, "tier": "Basic" }, @@ -67,8 +67,8 @@ "location": "eastus", "sku": { "capacity": 2, - "family": "Gen4", - "name": "B_Gen4_2", + "family": "Gen5", + "name": "B_Gen5_2", "size": null, "tier": "Basic" }, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreate.json index 54fd1d54300a..95e43a06f2fd 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreate.json @@ -18,10 +18,10 @@ "createMode": "Default" }, "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", "capacity": 2, - "family": "Gen4" + "family": "Gen5" }, "tags": { "ElasticServer": "1" @@ -32,9 +32,9 @@ "201": { "body": { "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { @@ -66,9 +66,9 @@ "type": "Microsoft.DBforMySQL/servers", "location": "westus", "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "tags": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreateGeoRestoreMode.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreateGeoRestoreMode.json index 7be8e9bd9de3..24ed1b914bbb 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreateGeoRestoreMode.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreateGeoRestoreMode.json @@ -11,9 +11,9 @@ "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/SourceResourceGroup/providers/Microsoft.DBforMySQL/servers/sourceserver" }, "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "tags": { @@ -25,9 +25,9 @@ "201": { "body": { "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { @@ -59,9 +59,9 @@ "type": "Microsoft.DBforMySQL/servers", "location": "westus", "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "tags": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreatePointInTimeRestore.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreatePointInTimeRestore.json index 84681fe7f260..bba4057c8d8c 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreatePointInTimeRestore.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreatePointInTimeRestore.json @@ -12,9 +12,9 @@ "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/SourceResourceGroup/providers/Microsoft.DBforMySQL/servers/sourceserver" }, "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "tags": { @@ -26,9 +26,9 @@ "201": { "body": { "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { @@ -60,9 +60,9 @@ "type": "Microsoft.DBforMySQL/servers", "location": "brazilsouth", "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "tags": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreateReplicaMode.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreateReplicaMode.json index c9857560febb..c906294eb2ae 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreateReplicaMode.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/ServerCreateReplicaMode.json @@ -16,9 +16,9 @@ "201": { "body": { "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { @@ -49,9 +49,9 @@ "200": { "body": { "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { 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 7670c459eeeb..f8a73d632373 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 @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "NetworkResourceProviderClient", - "description": "The Windows Azure Network management API provides a RESTful set of web services that interact with Windows Azure Networks service to manage your network resrources. The API has entities that capture the relationship between an end user and the Windows Azure Networks service.", + "description": "The Windows Azure Network management API provides a RESTful set of web services that interact with Windows Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Windows Azure Networks service.", "version": "2015-05-01-preview" }, "host": "management.azure.com", @@ -42,7 +42,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_Delete", - "description": "The delete applicationgateway operation deletes the specified applicationgateway.", + "description": "The delete application gateway operation deletes the specified application gateway.", "parameters": [ { "name": "resourceGroupName", @@ -56,7 +56,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the applicationgateway." + "description": "The name of the application gateway." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -83,7 +83,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_Get", - "description": "The Get applicationgateway operation retreives information about the specified applicationgateway.", + "description": "The Get application gateway operation retrieves information about the specified application gateway.", "parameters": [ { "name": "resourceGroupName", @@ -97,7 +97,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the applicationgateway." + "description": "The name of the application gateway." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -175,7 +175,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_List", - "description": "The List ApplicationGateway opertion retrieves all the applicationgateways in a resource group.", + "description": "The List ApplicationGateway operation retrieves all the application gateways in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -210,7 +210,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAll", - "description": "The List applicationgateway opertion retrieves all the applicationgateways in a subscription.", + "description": "The List application gateway operation retrieves all the application gateways in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -238,7 +238,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_Start", - "description": "The Start ApplicationGateway operation starts application gatewayin the specified resource group through Network resource provider.", + "description": "The Start ApplicationGateway operation starts application gateway in the specified resource group through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -275,7 +275,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_Stop", - "description": "The STOP ApplicationGateway operation stops application gatewayin the specified resource group through Network resource provider.", + "description": "The STOP ApplicationGateway operation stops application gateway in the specified resource group through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -356,7 +356,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_Get", - "description": "The Get ExpressRouteCircuit operation retreives information about the specified ExpressRouteCircuit.", + "description": "The Get ExpressRouteCircuit operation retrieves information about the specified ExpressRouteCircuit.", "parameters": [ { "name": "resourceGroupName", @@ -448,7 +448,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_ListArpTable", - "description": "The ListArpTable from ExpressRouteCircuit opertion retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.", + "description": "The ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -490,7 +490,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_ListRoutesTable", - "description": "The ListRoutesTable from ExpressRouteCircuit opertion retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.", + "description": "The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -532,7 +532,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_ListStats", - "description": "The Liststats ExpressRouteCircuit opertion retrieves all the stats from a ExpressRouteCircuits in a resource group.", + "description": "The ListStats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -574,7 +574,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_List", - "description": "The List ExpressRouteCircuit opertion retrieves all the ExpressRouteCircuits in a resource group.", + "description": "The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -609,7 +609,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_ListAll", - "description": "The List ExpressRouteCircuit opertion retrieves all the ExpressRouteCircuits in a subscription.", + "description": "The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -637,7 +637,7 @@ "ExpressRouteServiceProviders" ], "operationId": "ExpressRouteServiceProviders_List", - "description": "The List ExpressRouteServiceProvider opertion retrieves all the available ExpressRouteServiceProviders.", + "description": "The List ExpressRouteServiceProvider operation retrieves all the available ExpressRouteServiceProviders.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -757,7 +757,7 @@ "ExpressRouteCircuitPeerings" ], "operationId": "ExpressRouteCircuitPeerings_CreateOrUpdate", - "description": "The Put Pering operation creates/updates an peering in the specified ExpressRouteCircuits", + "description": "The Put Peering operation creates/updates an peering in the specified ExpressRouteCircuits", "parameters": [ { "name": "resourceGroupName", @@ -833,7 +833,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the curcuit." + "description": "The name of the circuit." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -902,7 +902,7 @@ "LoadBalancers" ], "operationId": "LoadBalancers_Get", - "description": "The Get ntework interface operation retreives information about the specified network interface.", + "description": "The Get network interface operation retrieves information about the specified network interface.", "parameters": [ { "name": "resourceGroupName", @@ -994,7 +994,7 @@ "LoadBalancers" ], "operationId": "LoadBalancers_ListAll", - "description": "The List loadBalancer opertion retrieves all the loadbalancers in a subscription.", + "description": "The List loadBalancer operation retrieves all the load balancers in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1022,7 +1022,7 @@ "LoadBalancers" ], "operationId": "LoadBalancers_List", - "description": "The List loadBalancer opertion retrieves all the loadbalancers in a resource group.", + "description": "The List loadBalancer operation retrieves all the load balancers in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1149,7 +1149,7 @@ "LocalNetworkGateways" ], "operationId": "LocalNetworkGateways_Delete", - "description": "The Delete LocalNetworkGateway operation deletes the specifed local network Gateway through Network resource provider.", + "description": "The Delete LocalNetworkGateway operation deletes the specified local network Gateway through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -1192,7 +1192,7 @@ "LocalNetworkGateways" ], "operationId": "LocalNetworkGateways_List", - "description": "The List LocalNetworkGateways opertion retrieves all the local network gateways stored.", + "description": "The List LocalNetworkGateways operation retrieves all the local network gateways stored.", "parameters": [ { "name": "resourceGroupName", @@ -1227,7 +1227,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_Delete", - "description": "The delete netwokInterface operation deletes the specified netwokInterface.", + "description": "The delete networkInterface operation deletes the specified networkInterface.", "parameters": [ { "name": "resourceGroupName", @@ -1268,7 +1268,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_Get", - "description": "The Get ntework interface operation retreives information about the specified network interface.", + "description": "The Get network interface operation retrieves information about the specified network interface.", "parameters": [ { "name": "resourceGroupName", @@ -1451,7 +1451,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetNetworkInterface", - "description": "The Get ntework interface operation retreives information about the specified network interface in a virtual machine scale set.", + "description": "The Get network interface operation retrieves information about the specified network interface in a virtual machine scale set.", "parameters": [ { "name": "resourceGroupName", @@ -1504,7 +1504,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_ListAll", - "description": "The List networkInterfaces opertion retrieves all the networkInterfaces in a subscription.", + "description": "The List networkInterfaces operation retrieves all the networkInterfaces in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1532,7 +1532,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_List", - "description": "The List networkInterfaces opertion retrieves all the networkInterfaces in a resource group.", + "description": "The List networkInterfaces operation retrieves all the networkInterfaces in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1567,7 +1567,7 @@ "RouteTables" ], "operationId": "RouteTables_Delete", - "description": "The Delete RouteTable operation deletes the specifed Route Table", + "description": "The Delete RouteTable operation deletes the specified Route Table", "parameters": [ { "name": "resourceGroupName", @@ -1645,7 +1645,7 @@ "RouteTables" ], "operationId": "RouteTables_CreateOrUpdate", - "description": "The Put RouteTable operation creates/updates a route tablein the specified resource group.", + "description": "The Put RouteTable operation creates/updates a route table in the specified resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1763,7 +1763,7 @@ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_Delete", - "description": "The Delete NetworkSecurityGroup operation deletes the specifed network security group", + "description": "The Delete NetworkSecurityGroup operation deletes the specified network security group", "parameters": [ { "name": "resourceGroupName", @@ -1841,7 +1841,7 @@ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_CreateOrUpdate", - "description": "The Put NetworkSecurityGroup operation creates/updates a network security groupin the specified resource group.", + "description": "The Put NetworkSecurityGroup operation creates/updates a network security group in the specified resource group.", "parameters": [ { "name": "resourceGroupName", @@ -2000,7 +2000,7 @@ "PublicIpAddresses" ], "operationId": "PublicIpAddresses_Get", - "description": "The Get publicIpAddress operation retreives information about the specified pubicIpAddress", + "description": "The Get publicIpAddress operation retrieves information about the specified pubicIpAddress", "parameters": [ { "name": "resourceGroupName", @@ -2092,7 +2092,7 @@ "PublicIpAddresses" ], "operationId": "PublicIpAddresses_ListAll", - "description": "The List publicIpAddress opertion retrieves all the publicIpAddresses in a subscription.", + "description": "The List publicIpAddress operation retrieves all the publicIpAddresses in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2120,7 +2120,7 @@ "PublicIpAddresses" ], "operationId": "PublicIpAddresses_List", - "description": "The List publicIpAddress opertion retrieves all the publicIpAddresses in a resource group.", + "description": "The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -2203,7 +2203,7 @@ "Routes" ], "operationId": "Routes_Get", - "description": "The Get route operation retreives information about the specified route from the route table.", + "description": "The Get route operation retrieves information about the specified route from the route table.", "parameters": [ { "name": "resourceGroupName", @@ -2277,7 +2277,7 @@ "schema": { "$ref": "#/definitions/Route" }, - "description": "Parameters supplied to the create/update routeoperation" + "description": "Parameters supplied to the create/update route operation" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -2309,7 +2309,7 @@ "Routes" ], "operationId": "Routes_List", - "description": "The List network security rule opertion retrieves all the routes in a route table.", + "description": "The List network security rule operation retrieves all the routes in a route table.", "parameters": [ { "name": "resourceGroupName", @@ -2399,7 +2399,7 @@ "SecurityRules" ], "operationId": "SecurityRules_Get", - "description": "The Get NetworkSecurityRule operation retreives information about the specified network security rule.", + "description": "The Get NetworkSecurityRule operation retrieves information about the specified network security rule.", "parameters": [ { "name": "resourceGroupName", @@ -2505,7 +2505,7 @@ "SecurityRules" ], "operationId": "SecurityRules_List", - "description": "The List network security rule opertion retrieves all the security rules in a network security group.", + "description": "The List network security rule operation retrieves all the security rules in a network security group.", "parameters": [ { "name": "resourceGroupName", @@ -2639,7 +2639,7 @@ "ExpressRouteCircuitAuthorizations" ], "operationId": "ExpressRouteCircuitAuthorizations_CreateOrUpdate", - "description": "The Put Authorization operation creates/updates an authorization in thespecified ExpressRouteCircuits", + "description": "The Put Authorization operation creates/updates an authorization in the specified ExpressRouteCircuits", "parameters": [ { "name": "resourceGroupName", @@ -2715,7 +2715,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the curcuit." + "description": "The name of the circuit." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -2791,7 +2791,7 @@ "Subnets" ], "operationId": "Subnets_Get", - "description": "The Get subnet operation retreives information about the specified subnet.", + "description": "The Get subnet operation retrieves information about the specified subnet.", "parameters": [ { "name": "resourceGroupName", @@ -2835,7 +2835,7 @@ "Subnets" ], "operationId": "Subnets_CreateOrUpdate", - "description": "The Put Subnet operation creates/updates a subnet in thespecified virtual network", + "description": "The Put Subnet operation creates/updates a subnet in the specified virtual network", "parameters": [ { "name": "resourceGroupName", @@ -2897,7 +2897,7 @@ "Subnets" ], "operationId": "Subnets_List", - "description": "The List subnets opertion retrieves all the subnets in a virtual network.", + "description": "The List subnets operation retrieves all the subnets in a virtual network.", "parameters": [ { "name": "resourceGroupName", @@ -2989,7 +2989,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the virtual network gateway conenction." + "description": "The name of the virtual network gateway connection." }, { "name": "parameters", @@ -3067,7 +3067,7 @@ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_Delete", - "description": "The Delete VirtualNetworkGatewayConnection operation deletes the specifed virtual network Gateway connection through Network resource provider.", + "description": "The Delete VirtualNetworkGatewayConnection operation deletes the specified virtual network Gateway connection through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -3170,7 +3170,7 @@ "schema": { "$ref": "#/definitions/ConnectionSharedKey" }, - "description": "Parameters supplied to the Begin Set Virtual Network Gateway conection Shared key operation throughNetwork resource provider." + "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation through Network resource provider." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -3381,7 +3381,7 @@ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_Delete", - "description": "The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.", + "description": "The Delete VirtualNetworkGateway operation deletes the specified virtual network Gateway through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -3424,7 +3424,7 @@ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_List", - "description": "The List VirtualNetworkGateways opertion retrieves all the virtual network gateways stored.", + "description": "The List VirtualNetworkGateways operation retrieves all the virtual network gateways stored.", "parameters": [ { "name": "resourceGroupName", @@ -3459,7 +3459,7 @@ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_Reset", - "description": "The Reset VirtualNetworkGateway operation resets the primary of the virtual network gatewayin the specified resource group through Network resource provider.", + "description": "The Reset VirtualNetworkGateway operation resets the primary of the virtual network gateway in the specified resource group through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -3511,7 +3511,7 @@ "VirtualNetworks" ], "operationId": "VirtualNetworks_Delete", - "description": "The Delete VirtualNetwork operation deletes the specifed virtual network", + "description": "The Delete VirtualNetwork operation deletes the specified virtual network", "parameters": [ { "name": "resourceGroupName", @@ -3777,7 +3777,7 @@ "properties": { "subnet": { "$ref": "#/definitions/SubResource", - "description": "Gets or sets the reference of the subnet resource.A subnet from where appliation gateway gets its private address " + "description": "Gets or sets the reference of the subnet resource.A subnet from where application gateway gets its private address " }, "provisioningState": { "type": "string", @@ -4403,7 +4403,7 @@ "description": "Gets or Sets RoutingRegistryName of the config." } }, - "description": "Specfies the peering config" + "description": "Specifies the peering config" }, "ExpressRouteCircuitStats": { "properties": { @@ -4484,7 +4484,7 @@ }, "microsoftPeeringConfig": { "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", - "description": "Gets or sets the mircosoft peering config" + "description": "Gets or sets the Microsoft peering config" }, "stats": { "$ref": "#/definitions/ExpressRouteCircuitStats", @@ -4832,7 +4832,7 @@ }, "subnet": { "$ref": "#/definitions/SubResource", - "description": "Gets or sets the reference of the subnet resource.A subnet from wher the load balancer gets its private frontend address " + "description": "Gets or sets the reference of the subnet resource.A subnet from where the load balancer gets its private frontend address " }, "publicIPAddress": { "$ref": "#/definitions/SubResource", @@ -4942,7 +4942,7 @@ "$ref": "#/definitions/SubResource" } ], - "description": "Pool of backend IP addresseses" + "description": "Pool of backend IP addresses" }, "LoadBalancingRulePropertiesFormat": { "properties": { @@ -4991,12 +4991,12 @@ "backendPort": { "type": "integer", "format": "int32", - "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal compotnent on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" + "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" }, "idleTimeoutInMinutes": { "type": "integer", "format": "int32", - "description": "Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This emlement is only used when the protocol is set to Tcp" + "description": "Gets or sets 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", @@ -5071,7 +5071,7 @@ "numberOfProbes": { "type": "integer", "format": "int32", - "description": "Gets or sets the number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endponints to be taken out of rotation faster or slower than the typical times used in Azure. " + "description": "Gets or sets 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", @@ -5121,7 +5121,7 @@ }, "protocol": { "type": "string", - "description": "Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp", + "description": "Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp", "enum": [ "Udp", "Tcp" @@ -5134,17 +5134,17 @@ "frontendPort": { "type": "integer", "format": "int32", - "description": "Gets or sets the port for the external endpoint. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" + "description": "Gets or sets the port for the external endpoint. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" }, "backendPort": { "type": "integer", "format": "int32", - "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal compotnent on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" + "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" }, "idleTimeoutInMinutes": { "type": "integer", "format": "int32", - "description": "Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This emlement is only used when the protocol is set to Tcp" + "description": "Gets or sets 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", @@ -5192,7 +5192,7 @@ }, "protocol": { "type": "string", - "description": "Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp", + "description": "Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp", "enum": [ "Udp", "Tcp" @@ -5205,17 +5205,17 @@ "frontendPortRangeStart": { "type": "integer", "format": "int32", - "description": "Gets or sets the starting port range for the NAT pool. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" + "description": "Gets or sets the starting port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" }, "frontendPortRangeEnd": { "type": "integer", "format": "int32", - "description": "Gets or sets the ending port range for the NAT pool. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" + "description": "Gets or sets the ending port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" }, "backendPort": { "type": "integer", "format": "int32", - "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal compotnent on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" + "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" }, "provisioningState": { "type": "string", @@ -5317,14 +5317,14 @@ "items": { "$ref": "#/definitions/BackendAddressPool" }, - "description": "Gets or sets Pools of backend IP addresseses" + "description": "Gets or sets Pools of backend IP addresses" }, "loadBalancingRules": { "type": "array", "items": { "$ref": "#/definitions/LoadBalancingRule" }, - "description": "Gets or sets loadbalancing rules" + "description": "Gets or sets load balancing rules" }, "probes": { "type": "array", @@ -5557,7 +5557,7 @@ }, "internalFqdn": { "type": "string", - "description": "Gets or sets full IDNS name in the form, DnsName.VnetId.ZoneId.TopleveSuffix. This is set when the NIC is associated to a VM" + "description": "Gets or sets full IDNS name in the form, DnsName.VnetId.ZoneId.TopLevelSuffix. This is set when the NIC is associated to a VM" } }, "description": "Dns Settings of a network interface" @@ -5752,7 +5752,7 @@ "description": "Gets the URL to get the next set of results." } }, - "description": "Response for ListRouteTable Api servive call" + "description": "Response for ListRouteTable Api service call" }, "SecurityRulePropertiesFormat": { "properties": { @@ -5775,19 +5775,19 @@ }, "sourcePortRange": { "type": "string", - "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." }, "destinationPortRange": { "type": "string", - "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." }, "sourceAddressPrefix": { "type": "string", - "description": "Gets or sets source address prefix. 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. " + "description": "Gets or sets source address prefix. CIDR or source IP range. Asterisk '*' 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. " }, "destinationAddressPrefix": { "type": "string", - "description": "Gets or sets destination address prefix. 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. " + "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. " }, "access": { "type": "string", @@ -5808,7 +5808,7 @@ }, "direction": { "type": "string", - "description": "Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic.", + "description": "Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", "enum": [ "Inbound", "Outbound" @@ -5926,7 +5926,7 @@ "description": "Gets the URL to get the next set of results." } }, - "description": "Response for ListNetworkSecurityGroups Api servive call" + "description": "Response for ListNetworkSecurityGroups Api service call" }, "PublicIpAddressDnsSettings": { "properties": { @@ -5940,7 +5940,7 @@ }, "reverseFqdn": { "type": "string", - "description": "Gets or Sests 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": "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" @@ -5974,7 +5974,7 @@ "idleTimeoutInMinutes": { "type": "integer", "format": "int32", - "description": "Gets or sets the Idletimeout of the public IP address" + "description": "Gets or sets the idle timeout of the public IP address" }, "resourceGuid": { "type": "string", @@ -6038,7 +6038,7 @@ "description": "Gets the URL to get the next set of results." } }, - "description": "Response for ListRoute Api servive call" + "description": "Response for ListRoute Api service call" }, "SecurityRuleListResult": { "properties": { @@ -6122,7 +6122,7 @@ "$ref": "#/definitions/SubResource" } ], - "description": "Subnet in a VirtualNework resource" + "description": "Subnet in a VirtualNetwork resource" }, "SubnetListResult": { "properties": { @@ -6310,7 +6310,7 @@ "description": "Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed" } }, - "description": "VirtualNeworkGateay properties" + "description": "VirtualNetworkGateway properties" }, "VirtualNetworkGateway": { "properties": { @@ -6343,7 +6343,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type -Ipsec/Dedicated/VpnClient/Vnet2Vnet", + "description": "Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet", "enum": [ "IPsec", "Vnet2Vnet", @@ -6362,7 +6362,7 @@ }, "sharedKey": { "type": "string", - "description": "The Ipsec share key." + "description": "The IPsec share key." }, "connectionStatus": { "type": "string", @@ -6401,7 +6401,7 @@ "description": "Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed" } }, - "description": "VirtualNeworkGatewayConnection properties" + "description": "VirtualNetworkGatewayConnection properties" }, "VirtualNetworkGatewayConnection": { "properties": { @@ -6428,7 +6428,7 @@ "description": "The virtual network connection shared key value" } }, - "description": "Response for GetConnectionSharedKey Api servive call" + "description": "Response for GetConnectionSharedKey Api service call" }, "VirtualNetworkGatewayConnectionListResult": { "properties": { @@ -6542,7 +6542,7 @@ "description": "Gets the URL to get the next set of results." } }, - "description": "Response for ListVirtualNetworks Api servive call" + "description": "Response for ListVirtualNetworks Api service call" }, "DnsNameAvailabilityResult": { "properties": { @@ -6551,7 +6551,7 @@ "description": "Domain availability (True/False)" } }, - "description": "Response for CheckDnsNameAvailability Api servive call" + "description": "Response for CheckDnsNameAvailability Api service call" }, "ErrorDetails": { "properties": { @@ -6607,7 +6607,7 @@ "$ref": "#/definitions/Error" } }, - "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, 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." + "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": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/loadBalancer.json index 983adbfb3eb5..054c993d89a7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/loadBalancer.json @@ -463,7 +463,7 @@ "$ref": "./network.json#/definitions/SubResource" } ], - "description": "A loag balancing rule for a load balancer." + "description": "A load balancing rule for a load balancer." }, "ProbePropertiesFormat": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/networkSecurityGroup.json index 93aab523e525..c35d30f2d3e1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/networkSecurityGroup.json @@ -458,19 +458,19 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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. " }, "destinationAddressPrefix": { "type": "string", - "description": "The destination address prefix. 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." + "description": "The destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "access": { "type": "string", @@ -491,7 +491,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/virtualNetworkGateway.json index db16f1631027..07fe96ade87a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/virtualNetworkGateway.json @@ -553,7 +553,7 @@ "schema": { "$ref": "#/definitions/ConnectionSharedKey" }, - "description": "Parameters supplied to the Begin Set Virtual Network Gateway conection Shared key operation throughNetwork resource provider." + "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1121,7 +1121,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -1211,7 +1211,7 @@ "description": "The virtual network connection shared key value" } }, - "description": "Response for CheckConnectionSharedKey Api servive call" + "description": "Response for CheckConnectionSharedKey API service call" }, "VirtualNetworkGatewayConnectionListResult": { "properties": { @@ -1245,7 +1245,7 @@ "description": "The virtual network connection shared key value" } }, - "description": "Response for GetConnectionSharedKey Api servive call" + "description": "Response for GetConnectionSharedKey API service call" }, "LocalNetworkGatewayPropertiesFormat": { "properties": { 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 b95b913bb10d..d77a8621bb16 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 @@ -2,7 +2,7 @@ "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 resrources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "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": "2016-03-30" }, "host": "management.azure.com", @@ -42,7 +42,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_Delete", - "description": "The delete applicationgateway operation deletes the specified applicationgateway.", + "description": "The delete application gateway operation deletes the specified application gateway.", "parameters": [ { "name": "resourceGroupName", @@ -56,7 +56,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the applicationgateway." + "description": "The name of the application gateway." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -83,7 +83,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_Get", - "description": "The Get applicationgateway operation retreives information about the specified applicationgateway.", + "description": "The Get application gateway operation retrieves information about the specified application gateway.", "parameters": [ { "name": "resourceGroupName", @@ -97,7 +97,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the applicationgateway." + "description": "The name of the application gateway." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -175,7 +175,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_List", - "description": "The List ApplicationGateway opertion retrieves all the applicationgateways in a resource group.", + "description": "The List ApplicationGateway operation retrieves all the application gateways in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -210,7 +210,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_ListAll", - "description": "The List applicationgateway opertion retrieves all the applicationgateways in a subscription.", + "description": "The List application gateway operation retrieves all the application gateways in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -238,7 +238,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_Start", - "description": "The Start ApplicationGateway operation starts application gatewayin the specified resource group through Network resource provider.", + "description": "The Start ApplicationGateway operation starts application gateway in the specified resource group through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -278,7 +278,7 @@ "ApplicationGateways" ], "operationId": "ApplicationGateways_Stop", - "description": "The STOP ApplicationGateway operation stops application gatewayin the specified resource group through Network resource provider.", + "description": "The STOP ApplicationGateway operation stops application gateway in the specified resource group through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -410,7 +410,7 @@ "ExpressRouteCircuitAuthorizations" ], "operationId": "ExpressRouteCircuitAuthorizations_CreateOrUpdate", - "description": "The Put Authorization operation creates/updates an authorization in thespecified ExpressRouteCircuits", + "description": "The Put Authorization operation creates/updates an authorization in the specified ExpressRouteCircuits", "parameters": [ { "name": "resourceGroupName", @@ -486,7 +486,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the curcuit." + "description": "The name of the circuit." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -606,7 +606,7 @@ "ExpressRouteCircuitPeerings" ], "operationId": "ExpressRouteCircuitPeerings_CreateOrUpdate", - "description": "The Put Pering operation creates/updates an peering in the specified ExpressRouteCircuits", + "description": "The Put Peering operation creates/updates an peering in the specified ExpressRouteCircuits", "parameters": [ { "name": "resourceGroupName", @@ -682,7 +682,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the curcuit." + "description": "The name of the circuit." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -751,7 +751,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_Get", - "description": "The Get ExpressRouteCircuit operation retreives information about the specified ExpressRouteCircuit.", + "description": "The Get ExpressRouteCircuit operation retrieves information about the specified ExpressRouteCircuit.", "parameters": [ { "name": "resourceGroupName", @@ -843,7 +843,7 @@ "ExpressRouteCircuitArpTable" ], "operationId": "ExpressRouteCircuits_ListArpTable", - "description": "The ListArpTable from ExpressRouteCircuit opertion retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.", + "description": "The ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -900,7 +900,7 @@ "ExpressRouteCircuitRoutesTable" ], "operationId": "ExpressRouteCircuits_ListRoutesTable", - "description": "The ListRoutesTable from ExpressRouteCircuit opertion retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.", + "description": "The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -957,7 +957,7 @@ "ExpressRouteCircuitRoutesTableSummary" ], "operationId": "ExpressRouteCircuits_ListRoutesTableSummary", - "description": "The ListRoutesTable from ExpressRouteCircuit opertion retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.", + "description": "The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1014,7 +1014,7 @@ "ExpressRouteCircuitStats" ], "operationId": "ExpressRouteCircuits_GetStats", - "description": "The Liststats ExpressRouteCircuit opertion retrieves all the stats from a ExpressRouteCircuits in a resource group.", + "description": "The GetStats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1053,7 +1053,7 @@ "ExpressRouteCircuitStats" ], "operationId": "ExpressRouteCircuits_GetPeeringStats", - "description": "The Liststats ExpressRouteCircuit opertion retrieves all the stats from a ExpressRouteCircuits in a resource group.", + "description": "The GetPeeringStats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1099,7 +1099,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_List", - "description": "The List ExpressRouteCircuit opertion retrieves all the ExpressRouteCircuits in a resource group.", + "description": "The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1134,7 +1134,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_ListAll", - "description": "The List ExpressRouteCircuit opertion retrieves all the ExpressRouteCircuits in a subscription.", + "description": "The List ExpressRouteCircuit operation retrieves all the ExpressRouteCircuits in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1162,7 +1162,7 @@ "ExpressRouteServiceProviders" ], "operationId": "ExpressRouteServiceProviders_List", - "description": "The List ExpressRouteServiceProvider opertion retrieves all the available ExpressRouteServiceProviders.", + "description": "The List ExpressRouteServiceProvider operation retrieves all the available ExpressRouteServiceProviders.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1231,7 +1231,7 @@ "LoadBalancers" ], "operationId": "LoadBalancers_Get", - "description": "The Get ntework interface operation retreives information about the specified network interface.", + "description": "The Get network interface operation retrieves information about the specified network interface.", "parameters": [ { "name": "resourceGroupName", @@ -1330,7 +1330,7 @@ "LoadBalancers" ], "operationId": "LoadBalancers_ListAll", - "description": "The List loadBalancer opertion retrieves all the loadbalancers in a subscription.", + "description": "The List loadBalancer operation retrieves all the load balancers in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1358,7 +1358,7 @@ "LoadBalancers" ], "operationId": "LoadBalancers_List", - "description": "The List loadBalancer opertion retrieves all the loadbalancers in a resource group.", + "description": "The List loadBalancer operation retrieves all the load balancers in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1483,7 +1483,7 @@ "LocalNetworkGateways" ], "operationId": "LocalNetworkGateways_Delete", - "description": "The Delete LocalNetworkGateway operation deletes the specifed local network Gateway through Network resource provider.", + "description": "The Delete LocalNetworkGateway operation deletes the specified local network Gateway through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -1526,7 +1526,7 @@ "LocalNetworkGateways" ], "operationId": "LocalNetworkGateways_List", - "description": "The List LocalNetworkGateways opertion retrieves all the local network gateways stored.", + "description": "The List LocalNetworkGateways operation retrieves all the local network gateways stored.", "parameters": [ { "name": "resourceGroupName", @@ -1561,7 +1561,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_Delete", - "description": "The delete netwokInterface operation deletes the specified netwokInterface.", + "description": "The delete networkInterface operation deletes the specified networkInterface.", "parameters": [ { "name": "resourceGroupName", @@ -1602,7 +1602,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_Get", - "description": "The Get ntework interface operation retreives information about the specified network interface.", + "description": "The Get network interface operation retrieves information about the specified network interface.", "parameters": [ { "name": "resourceGroupName", @@ -1792,7 +1792,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetNetworkInterface", - "description": "The Get ntework interface operation retreives information about the specified network interface in a virtual machine scale set.", + "description": "The Get network interface operation retrieves information about the specified network interface in a virtual machine scale set.", "parameters": [ { "name": "resourceGroupName", @@ -1852,7 +1852,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_ListAll", - "description": "The List networkInterfaces opertion retrieves all the networkInterfaces in a subscription.", + "description": "The List networkInterfaces operation retrieves all the networkInterfaces in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -1880,7 +1880,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_List", - "description": "The List networkInterfaces opertion retrieves all the networkInterfaces in a resource group.", + "description": "The List networkInterfaces operation retrieves all the networkInterfaces in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -1915,7 +1915,7 @@ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_Delete", - "description": "The Delete NetworkSecurityGroup operation deletes the specifed network security group", + "description": "The Delete NetworkSecurityGroup operation deletes the specified network security group", "parameters": [ { "name": "resourceGroupName", @@ -2000,7 +2000,7 @@ "NetworkSecurityGroups" ], "operationId": "NetworkSecurityGroups_CreateOrUpdate", - "description": "The Put NetworkSecurityGroup operation creates/updates a network security groupin the specified resource group.", + "description": "The Put NetworkSecurityGroup operation creates/updates a network security group in the specified resource group.", "parameters": [ { "name": "resourceGroupName", @@ -2159,7 +2159,7 @@ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_Get", - "description": "The Get publicIpAddress operation retreives information about the specified pubicIpAddress", + "description": "The Get publicIpAddress operation retrieves information about the specified pubicIpAddress", "parameters": [ { "name": "resourceGroupName", @@ -2258,7 +2258,7 @@ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_ListAll", - "description": "The List publicIpAddress opertion retrieves all the publicIpAddresses in a subscription.", + "description": "The List publicIpAddress operation retrieves all the publicIpAddresses in a subscription.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2286,7 +2286,7 @@ "PublicIPAddresses" ], "operationId": "PublicIPAddresses_List", - "description": "The List publicIpAddress opertion retrieves all the publicIpAddresses in a resource group.", + "description": "The List publicIpAddress operation retrieves all the publicIpAddresses in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -2321,7 +2321,7 @@ "RouteTables" ], "operationId": "RouteTables_Delete", - "description": "The Delete RouteTable operation deletes the specifed Route Table", + "description": "The Delete RouteTable operation deletes the specified Route Table", "parameters": [ { "name": "resourceGroupName", @@ -2406,7 +2406,7 @@ "RouteTables" ], "operationId": "RouteTables_CreateOrUpdate", - "description": "The Put RouteTable operation creates/updates a route tablein the specified resource group.", + "description": "The Put RouteTable operation creates/updates a route table in the specified resource group.", "parameters": [ { "name": "resourceGroupName", @@ -2572,7 +2572,7 @@ "Routes" ], "operationId": "Routes_Get", - "description": "The Get route operation retreives information about the specified route from the route table.", + "description": "The Get route operation retrieves information about the specified route from the route table.", "parameters": [ { "name": "resourceGroupName", @@ -2646,7 +2646,7 @@ "schema": { "$ref": "#/definitions/Route" }, - "description": "Parameters supplied to the create/update routeoperation" + "description": "Parameters supplied to the create/update route operation" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -2678,7 +2678,7 @@ "Routes" ], "operationId": "Routes_List", - "description": "The List network security rule opertion retrieves all the routes in a route table.", + "description": "The List network security rule operation retrieves all the routes in a route table.", "parameters": [ { "name": "resourceGroupName", @@ -2768,7 +2768,7 @@ "SecurityRules" ], "operationId": "SecurityRules_Get", - "description": "The Get NetworkSecurityRule operation retreives information about the specified network security rule.", + "description": "The Get NetworkSecurityRule operation retrieves information about the specified network security rule.", "parameters": [ { "name": "resourceGroupName", @@ -2874,7 +2874,7 @@ "SecurityRules" ], "operationId": "SecurityRules_List", - "description": "The List network security rule opertion retrieves all the security rules in a network security group.", + "description": "The List network security rule operation retrieves all the security rules in a network security group.", "parameters": [ { "name": "resourceGroupName", @@ -2964,7 +2964,7 @@ "Subnets" ], "operationId": "Subnets_Get", - "description": "The Get subnet operation retreives information about the specified subnet.", + "description": "The Get subnet operation retrieves information about the specified subnet.", "parameters": [ { "name": "resourceGroupName", @@ -3015,7 +3015,7 @@ "Subnets" ], "operationId": "Subnets_CreateOrUpdate", - "description": "The Put Subnet operation creates/updates a subnet in thespecified virtual network", + "description": "The Put Subnet operation creates/updates a subnet in the specified virtual network", "parameters": [ { "name": "resourceGroupName", @@ -3077,7 +3077,7 @@ "Subnets" ], "operationId": "Subnets_List", - "description": "The List subnets opertion retrieves all the subnets in a virtual network.", + "description": "The List subnets operation retrieves all the subnets in a virtual network.", "parameters": [ { "name": "resourceGroupName", @@ -3169,7 +3169,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the virtual network gateway conenction." + "description": "The name of the virtual network gateway connection." }, { "name": "parameters", @@ -3245,7 +3245,7 @@ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_Delete", - "description": "The Delete VirtualNetworkGatewayConnection operation deletes the specifed virtual network Gateway connection through Network resource provider.", + "description": "The Delete VirtualNetworkGatewayConnection operation deletes the specified virtual network Gateway connection through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -3398,7 +3398,7 @@ "schema": { "$ref": "#/definitions/ConnectionSharedKey" }, - "description": "Parameters supplied to the Begin Set Virtual Network Gateway conection Shared key operation throughNetwork resource provider." + "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation through Network resource provider." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -3557,7 +3557,7 @@ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_Delete", - "description": "The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.", + "description": "The Delete VirtualNetworkGateway operation deletes the specified virtual network Gateway through Network resource provider.", "parameters": [ { "name": "resourceGroupName", @@ -3600,7 +3600,7 @@ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_List", - "description": "The List VirtualNetworkGateways opertion retrieves all the virtual network gateways stored.", + "description": "The List VirtualNetworkGateways operation retrieves all the virtual network gateways stored.", "parameters": [ { "name": "resourceGroupName", @@ -3735,7 +3735,7 @@ "VirtualNetworks" ], "operationId": "VirtualNetworks_Delete", - "description": "The Delete VirtualNetwork operation deletes the specifed virtual network", + "description": "The Delete VirtualNetwork operation deletes the specified virtual network", "parameters": [ { "name": "resourceGroupName", @@ -4008,7 +4008,7 @@ "properties": { "subnet": { "$ref": "#/definitions/SubResource", - "description": "Gets or sets the reference of the subnet resource.A subnet from where appliation gateway gets its private address " + "description": "Gets or sets the reference of the subnet resource.A subnet from where application gateway gets its private address " }, "provisioningState": { "type": "string", @@ -4627,7 +4627,7 @@ }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the ApplicationGateway resource" + "description": "Gets or sets resource GUID property of the ApplicationGateway resource" }, "provisioningState": { "type": "string", @@ -4811,7 +4811,7 @@ "description": "Gets or Sets RoutingRegistryName of the config." } }, - "description": "Specfies the peering config" + "description": "Specifies the peering config" }, "ExpressRouteCircuitStats": { "properties": { @@ -4902,7 +4902,7 @@ }, "microsoftPeeringConfig": { "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", - "description": "Gets or sets the mircosoft peering config" + "description": "Gets or sets the Microsoft peering config" }, "stats": { "$ref": "#/definitions/ExpressRouteCircuitStats", @@ -5418,7 +5418,7 @@ "$ref": "#/definitions/SubResource" } ], - "description": "Pool of backend IP addresseses" + "description": "Pool of backend IP addresses" }, "LoadBalancingRulePropertiesFormat": { "properties": { @@ -5467,12 +5467,12 @@ "backendPort": { "type": "integer", "format": "int32", - "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal compotnent on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" + "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" }, "idleTimeoutInMinutes": { "type": "integer", "format": "int32", - "description": "Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This emlement is only used when the protocol is set to Tcp" + "description": "Gets or sets 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", @@ -5545,7 +5545,7 @@ "numberOfProbes": { "type": "integer", "format": "int32", - "description": "Gets or sets the number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endponints to be taken out of rotation faster or slower than the typical times used in Azure. " + "description": "Gets or sets 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", @@ -5595,7 +5595,7 @@ }, "protocol": { "type": "string", - "description": "Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp", + "description": "Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp", "enum": [ "Udp", "Tcp" @@ -5608,17 +5608,17 @@ "frontendPort": { "type": "integer", "format": "int32", - "description": "Gets or sets the port for the external endpoint. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" + "description": "Gets or sets the port for the external endpoint. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" }, "backendPort": { "type": "integer", "format": "int32", - "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal compotnent on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" + "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" }, "idleTimeoutInMinutes": { "type": "integer", "format": "int32", - "description": "Gets or sets the timeout for the Tcp idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This emlement is only used when the protocol is set to Tcp" + "description": "Gets or sets 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", @@ -5661,7 +5661,7 @@ }, "protocol": { "type": "string", - "description": "Gets or sets the transport potocol for the external endpoint. Possible values are Udp or Tcp", + "description": "Gets or sets the transport protocol for the external endpoint. Possible values are Udp or Tcp", "enum": [ "Udp", "Tcp" @@ -5674,17 +5674,17 @@ "frontendPortRangeStart": { "type": "integer", "format": "int32", - "description": "Gets or sets the starting port range for the NAT pool. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" + "description": "Gets or sets the starting port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" }, "frontendPortRangeEnd": { "type": "integer", "format": "int32", - "description": "Gets or sets the ending port range for the NAT pool. You can spcify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" + "description": "Gets or sets the ending port range for the NAT pool. You can specify any port number you choose, but the port numbers specified for each role in the service must be unique. Possible values range between 1 and 65535, inclusive" }, "backendPort": { "type": "integer", "format": "int32", - "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal compotnent on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" + "description": "Gets or sets a port used for internal connections on the endpoint. The localPort attribute maps the eternal port of the endpoint to an internal port on a role. This is useful in scenarios where a role must communicate to an internal component on a port that is different from the one that is exposed externally. If not specified, the value of localPort is the same as the port attribute. Set the value of localPort to '*' to automatically assign an unallocated port that is discoverable using the runtime API" }, "provisioningState": { "type": "string", @@ -5785,14 +5785,14 @@ "items": { "$ref": "#/definitions/BackendAddressPool" }, - "description": "Gets or sets Pools of backend IP addresseses" + "description": "Gets or sets Pools of backend IP addresses" }, "loadBalancingRules": { "type": "array", "items": { "$ref": "#/definitions/LoadBalancingRule" }, - "description": "Gets or sets loadbalancing rules" + "description": "Gets or sets load balancing rules" }, "probes": { "type": "array", @@ -5824,7 +5824,7 @@ }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the Load balancer resource" + "description": "Gets or sets resource GUID property of the Load balancer resource" }, "provisioningState": { "type": "string", @@ -5913,7 +5913,7 @@ }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the LocalNetworkGateway resource" + "description": "Gets or sets resource GUID property of the LocalNetworkGateway resource" }, "provisioningState": { "type": "string", @@ -6066,7 +6066,7 @@ }, "internalFqdn": { "type": "string", - "description": "Gets or sets the internal fqdn." + "description": "Gets or sets the internal FQDN." }, "internalDomainNameSuffix": { "type": "string", @@ -6110,7 +6110,7 @@ }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the network interface resource" + "description": "Gets or sets resource GUID property of the network interface resource" }, "provisioningState": { "type": "string", @@ -6174,19 +6174,19 @@ }, "sourcePortRange": { "type": "string", - "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." }, "destinationPortRange": { "type": "string", - "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." }, "sourceAddressPrefix": { "type": "string", - "description": "Gets or sets source address prefix. 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. " + "description": "Gets or sets source address prefix. CIDR or source IP range. Asterisk '*' 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. " }, "destinationAddressPrefix": { "type": "string", - "description": "Gets or sets destination address prefix. 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. " + "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. " }, "access": { "type": "string", @@ -6207,7 +6207,7 @@ }, "direction": { "type": "string", - "description": "Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic.", + "description": "Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", "enum": [ "Inbound", "Outbound" @@ -6284,7 +6284,7 @@ }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the network security group resource" + "description": "Gets or sets resource GUID property of the network security group resource" }, "provisioningState": { "type": "string", @@ -6325,7 +6325,7 @@ "description": "Gets the URL to get the next set of results." } }, - "description": "Response for ListNetworkSecurityGroups Api servive call" + "description": "Response for ListNetworkSecurityGroups Api service call" }, "PublicIPAddressDnsSettings": { "properties": { @@ -6339,7 +6339,7 @@ }, "reverseFqdn": { "type": "string", - "description": "Gets or Sests 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": "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" @@ -6383,11 +6383,11 @@ "idleTimeoutInMinutes": { "type": "integer", "format": "int32", - "description": "Gets or sets the Idletimeout of the public IP address" + "description": "Gets or sets the idle timeout of the public IP address" }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the PublicIP resource" + "description": "Gets or sets resource GUID property of the PublicIP resource" }, "provisioningState": { "type": "string", @@ -6542,7 +6542,7 @@ "description": "Gets the URL to get the next set of results." } }, - "description": "Response for ListRouteTable Api servive call" + "description": "Response for ListRouteTable Api service call" }, "RouteListResult": { "properties": { @@ -6558,7 +6558,7 @@ "description": "Gets the URL to get the next set of results." } }, - "description": "Response for ListRoute Api servive call" + "description": "Response for ListRoute Api service call" }, "SecurityRuleListResult": { "properties": { @@ -6678,7 +6678,7 @@ "$ref": "#/definitions/SubResource" } ], - "description": "Subnet in a VirtualNework resource" + "description": "Subnet in a VirtualNetwork resource" }, "SubnetListResult": { "properties": { @@ -6867,14 +6867,14 @@ }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetworkGateway resource" + "description": "Gets or sets resource GUID property of the VirtualNetworkGateway resource" }, "provisioningState": { "type": "string", "description": "Gets or sets Provisioning state of the VirtualNetworkGateway resource Updating/Deleting/Failed" } }, - "description": "VirtualNeworkGateay properties" + "description": "VirtualNetworkGateway properties" }, "VirtualNetworkGateway": { "properties": { @@ -6987,7 +6987,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type -Ipsec/Dedicated/VpnClient/Vnet2Vnet", + "description": "Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet", "enum": [ "IPsec", "Vnet2Vnet", @@ -7006,7 +7006,7 @@ }, "sharedKey": { "type": "string", - "description": "The Ipsec share key." + "description": "The IPsec share key." }, "connectionStatus": { "type": "string", @@ -7042,14 +7042,14 @@ }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetworkGatewayConnection resource" + "description": "Gets or sets resource GUID property of the VirtualNetworkGatewayConnection resource" }, "provisioningState": { "type": "string", "description": "Gets or sets Provisioning state of the VirtualNetworkGatewayConnection resource Updating/Deleting/Failed" } }, - "description": "VirtualNeworkGatewayConnection properties" + "description": "VirtualNetworkGatewayConnection properties" }, "VirtualNetworkGatewayConnection": { "properties": { @@ -7146,7 +7146,7 @@ "description": "The virtual network connection shared key value" } }, - "description": "Response for CheckConnectionSharedKey Api servive call" + "description": "Response for CheckConnectionSharedKey Api service call" }, "VirtualNetworkGatewayConnectionListResult": { "properties": { @@ -7180,7 +7180,7 @@ "description": "The virtual network connection shared key value" } }, - "description": "Response for GetConnectionSharedKey Api servive call" + "description": "Response for GetConnectionSharedKey Api service call" }, "VirtualNetworkGatewayListResult": { "properties": { @@ -7229,7 +7229,7 @@ }, "resourceGuid": { "type": "string", - "description": "Gets or sets resource guid property of the VirtualNetwork resource" + "description": "Gets or sets resource GUID property of the VirtualNetwork resource" }, "provisioningState": { "type": "string", @@ -7269,7 +7269,7 @@ "description": "Gets the URL to get the next set of results." } }, - "description": "Response for ListVirtualNetworks Api servive call" + "description": "Response for ListVirtualNetworks Api service call" }, "DnsNameAvailabilityResult": { "properties": { @@ -7278,7 +7278,7 @@ "description": "Domain availability (True/False)" } }, - "description": "Response for CheckDnsNameAvailability Api servive call" + "description": "Response for CheckDnsNameAvailability Api service call" }, "ErrorDetails": { "properties": { @@ -7334,7 +7334,7 @@ "$ref": "#/definitions/Error" } }, - "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, 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." + "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": { 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 ebacf99b783f..43066a06f0d4 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 @@ -1561,7 +1561,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_Delete", - "description": "The delete netwokInterface operation deletes the specified netwokInterface.", + "description": "The delete networkInterface operation deletes the specified networkInterface.", "parameters": [ { "name": "resourceGroupName", @@ -1915,7 +1915,7 @@ "NetworkInterfaces" ], "operationId": "NetworkInterfaces_GetEffectiveRouteTable", - "description": "The get effective routetable operation retrieves all the route tables applied on a networkInterface.", + "description": "Retrieves all the route tables applied on a networkInterface.", "parameters": [ { "name": "resourceGroupName", @@ -5301,7 +5301,7 @@ }, "microsoftPeeringConfig": { "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", - "description": "Gets or sets the mircosoft peering config" + "description": "Gets or sets the Microsoft peering config" }, "stats": { "$ref": "#/definitions/ExpressRouteCircuitStats", @@ -6594,19 +6594,19 @@ }, "sourcePortRange": { "type": "string", - "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." }, "destinationPortRange": { "type": "string", - "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." }, "sourceAddressPrefix": { "type": "string", - "description": "Gets or sets source address prefix. 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. " + "description": "Gets or sets source address prefix. CIDR or source IP range. Asterisk '*' 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. " }, "destinationAddressPrefix": { "type": "string", - "description": "Gets or sets destination address prefix. 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. " + "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. " }, "access": { "type": "string", @@ -6627,7 +6627,7 @@ }, "direction": { "type": "string", - "description": "Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outcoming traffic.", + "description": "Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", "enum": [ "Inbound", "Outbound" @@ -6935,7 +6935,7 @@ "idleTimeoutInMinutes": { "type": "integer", "format": "int32", - "description": "Gets or sets the Idletimeout of the public IP address" + "description": "Gets or sets the idle timeout of the public IP address" }, "resourceGuid": { "type": "string", @@ -7401,7 +7401,7 @@ "$ref": "#/definitions/SubResource" } ], - "description": "Subnet in a VirtualNework resource" + "description": "Subnet in a VirtualNetwork resource" }, "VirtualNetworkPeering": { "properties": { @@ -7423,7 +7423,7 @@ "$ref": "#/definitions/SubResource" } ], - "description": "Peerings in a VirtualNework resource" + "description": "Peerings in a VirtualNetwork resource" }, "SubnetListResult": { "properties": { @@ -7754,7 +7754,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type -Ipsec/Dedicated/VpnClient/Vnet2Vnet", + "description": "Gateway connection type IPsec/Dedicated/VpnClient/Vnet2Vnet", "enum": [ "IPsec", "Vnet2Vnet", @@ -7773,7 +7773,7 @@ }, "sharedKey": { "type": "string", - "description": "The Ipsec share key." + "description": "The IPsec share key." }, "connectionStatus": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/loadBalancer.json index a9e4c6ea276c..c6e47f5c3612 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/loadBalancer.json @@ -469,7 +469,7 @@ "$ref": "./network.json#/definitions/SubResource" } ], - "description": "A loag balancing rule for a load balancer." + "description": "A load balancing rule for a load balancer." }, "ProbePropertiesFormat": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/networkSecurityGroup.json index 1da3a101b612..8145b9a3f72b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/networkSecurityGroup.json @@ -458,19 +458,19 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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. " }, "destinationAddressPrefix": { "type": "string", - "description": "The destination address prefix. 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." + "description": "The destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "access": { "type": "string", @@ -491,7 +491,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/virtualNetworkGateway.json index 09085d2295db..cbb7bb9c136d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/virtualNetworkGateway.json @@ -226,8 +226,8 @@ "type": "string", "description": "The name of the virtual network gateway." }, - { - "name": "gatewayVip", + { + "name": "gatewayVip", "in": "query", "required": false, "type": "string", @@ -577,7 +577,7 @@ }, "x-ms-long-running-operation": true } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { "put": { "tags": [ @@ -668,7 +668,7 @@ } } } - } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { "get": { @@ -1421,19 +1421,19 @@ } }, "ingressBytesTransferred": { - "readOnly": true, + "readOnly": true, "type": "integer", "format": "int64", "description": "The Ingress Bytes Transferred in this connection" }, "egressBytesTransferred": { - "readOnly": true, + "readOnly": true, "type": "integer", "format": "int64", "description": "The Egress Bytes Transferred in this connection" - }, + }, "lastConnectionEstablishedUtcTime": { - "readOnly": true, + "readOnly": true, "type": "string", "description": "The time at which connection was established in Utc format." } @@ -1457,7 +1457,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -1597,7 +1597,7 @@ }, "required": [ "value" - ], + ], "description": "Response for GetConnectionSharedKey API service call" }, "LocalNetworkGatewayPropertiesFormat": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/networkSecurityGroup.json index a3e2d9b271e7..44e851827550 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/networkSecurityGroup.json @@ -458,19 +458,19 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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. " }, "destinationAddressPrefix": { "type": "string", - "description": "The destination address prefix. 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." + "description": "The destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "access": { "type": "string", @@ -491,7 +491,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/virtualNetworkGateway.json index a156da3cc892..7c14ea560280 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/virtualNetworkGateway.json @@ -226,8 +226,8 @@ "type": "string", "description": "The name of the virtual network gateway." }, - { - "name": "gatewayVip", + { + "name": "gatewayVip", "in": "query", "required": false, "type": "string", @@ -577,7 +577,7 @@ }, "x-ms-long-running-operation": true } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { "put": { "tags": [ @@ -668,7 +668,7 @@ } } } - } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { "get": { @@ -1408,19 +1408,19 @@ } }, "ingressBytesTransferred": { - "readOnly": true, + "readOnly": true, "type": "integer", "format": "int64", "description": "The Ingress Bytes Transferred in this connection" }, "egressBytesTransferred": { - "readOnly": true, + "readOnly": true, "type": "integer", "format": "int64", "description": "The Egress Bytes Transferred in this connection" - }, + }, "lastConnectionEstablishedUtcTime": { - "readOnly": true, + "readOnly": true, "type": "string", "description": "The time at which connection was established in Utc format." } @@ -1444,7 +1444,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -1584,7 +1584,7 @@ }, "required": [ "value" - ], + ], "description": "Response for GetConnectionSharedKey API service call" }, "LocalNetworkGatewayPropertiesFormat": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/networkSecurityGroup.json index 37609771ad03..2a7fa0ca5485 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/networkSecurityGroup.json @@ -458,19 +458,19 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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. " }, "destinationAddressPrefix": { "type": "string", - "description": "The destination address prefix. 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." + "description": "The destination address prefix. CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "access": { "type": "string", @@ -491,7 +491,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/virtualNetworkGateway.json index e99560ea410e..9e7b06292e42 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/virtualNetworkGateway.json @@ -226,8 +226,8 @@ "type": "string", "description": "The name of the virtual network gateway." }, - { - "name": "gatewayVip", + { + "name": "gatewayVip", "in": "query", "required": false, "type": "string", @@ -577,7 +577,7 @@ }, "x-ms-long-running-operation": true } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { "put": { "tags": [ @@ -668,7 +668,7 @@ } } } - } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { "get": { @@ -1420,19 +1420,19 @@ } }, "ingressBytesTransferred": { - "readOnly": true, + "readOnly": true, "type": "integer", "format": "int64", "description": "The Ingress Bytes Transferred in this connection" }, "egressBytesTransferred": { - "readOnly": true, + "readOnly": true, "type": "integer", "format": "int64", "description": "The Egress Bytes Transferred in this connection" - }, + }, "lastConnectionEstablishedUtcTime": { - "readOnly": true, + "readOnly": true, "type": "string", "description": "The time at which connection was established in Utc format." } @@ -1456,7 +1456,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -1608,7 +1608,7 @@ }, "required": [ "value" - ], + ], "description": "Response for GetConnectionSharedKey API service call" }, "IpsecPolicy": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/networkInterface.json index f98687be9695..8f1b7ca7fc51 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/networkInterface.json @@ -825,14 +825,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -847,14 +847,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/networkSecurityGroup.json index d45bba8b450a..daf5f217b025 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/networkSecurityGroup.json @@ -604,15 +604,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -623,7 +623,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -667,7 +667,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/virtualNetworkGateway.json index c3d0b48dd00e..5f14aea7f6be 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/virtualNetworkGateway.json @@ -1605,7 +1605,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -1983,7 +1983,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/networkInterface.json index b56933f28400..a68e3abc29ad 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/networkInterface.json @@ -805,14 +805,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -827,14 +827,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/networkSecurityGroup.json index f6435b607a01..17fc7f6afb74 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/networkSecurityGroup.json @@ -580,15 +580,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -599,7 +599,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -643,7 +643,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/virtualNetworkGateway.json index a3d8dbb9242a..3ea8fde84dde 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/virtualNetworkGateway.json @@ -1649,7 +1649,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2027,7 +2027,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/networkInterface.json index 677b2a8669a9..497081ed881a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/networkInterface.json @@ -862,14 +862,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -884,14 +884,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/networkSecurityGroup.json index 92ff8b1119be..a98700f4be00 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/networkSecurityGroup.json @@ -630,15 +630,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -656,7 +656,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -707,7 +707,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/virtualNetworkGateway.json index b5de12dbd436..3ef38ef18881 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/virtualNetworkGateway.json @@ -1887,7 +1887,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2265,7 +2265,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkInterface.json index 3442b62058c1..b9db9afe26db 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkInterface.json @@ -862,14 +862,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -884,14 +884,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkSecurityGroup.json index 75cd1245f0e1..e41775badfd1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkSecurityGroup.json @@ -630,15 +630,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -656,7 +656,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -707,7 +707,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkWatcher.json index 2d45dc0392bb..dcada8cb3720 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/networkWatcher.json @@ -2729,7 +2729,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -2901,7 +2901,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/virtualNetworkGateway.json index dfa503c6049e..074fd08f67b8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/virtualNetworkGateway.json @@ -1887,7 +1887,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2265,7 +2265,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkInterface.json index a6a50c3abc35..f199d93a8c2f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkInterface.json @@ -862,14 +862,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -884,14 +884,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkSecurityGroup.json index ff3122a9cab1..467bfd98b1dd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkSecurityGroup.json @@ -630,15 +630,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -656,7 +656,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -707,7 +707,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkWatcher.json index a01da6be5894..7a2c7f279308 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/networkWatcher.json @@ -2810,7 +2810,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -2982,7 +2982,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/virtualNetworkGateway.json index 2f4f81e19bd5..3ef3b48f7d76 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/virtualNetworkGateway.json @@ -1887,7 +1887,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2265,7 +2265,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/applicationGateway.json index 445c5e512356..67eb7c7609c6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/applicationGateway.json @@ -1750,7 +1750,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size for WAF." + "description": "Maximum request body size for WAF." } }, "required": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkInterface.json index af6db8dfe48c..42163649b39b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkInterface.json @@ -862,14 +862,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -884,14 +884,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkSecurityGroup.json index 88478b5526b5..91d6ff3a10d7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkSecurityGroup.json @@ -630,15 +630,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -656,7 +656,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -707,7 +707,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkWatcher.json index df8c1a1480f5..fee2ae22ef2d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/networkWatcher.json @@ -2889,7 +2889,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -3061,7 +3061,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/virtualNetworkGateway.json index 579597d8bfd2..3d3744e6d89d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/virtualNetworkGateway.json @@ -1887,7 +1887,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2265,7 +2265,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/applicationGateway.json index 4bcb293d0766..ac6ec01d4de2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/applicationGateway.json @@ -489,8 +489,8 @@ ], "operationId": "ApplicationGateways_ListAvailableSslOptions", "x-ms-examples": { - "Get Available Ssl Options": { - "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" + "Get Available Ssl Options": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" } }, "description": "Lists available Ssl options for configuring Ssl policy.", @@ -1738,19 +1738,19 @@ "$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." + }, + "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": "Maximum request body size for WAF." } }, "required": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/expressRouteCrossConnection.json index cce8fd01f745..bbebfdd30463 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/expressRouteCrossConnection.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/expressRouteCrossConnection.json @@ -53,7 +53,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } @@ -93,7 +93,7 @@ ], "responses": { "200": { - "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkInterface.json index 042b4c82c4d0..ad1131ff6a41 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkInterface.json @@ -862,14 +862,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -884,14 +884,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkSecurityGroup.json index 1320c3cc5098..964fbed085c9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkSecurityGroup.json @@ -630,15 +630,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -656,7 +656,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -707,7 +707,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkWatcher.json index b9101ece2b95..271b73c2c21d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/networkWatcher.json @@ -2797,7 +2797,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -2982,7 +2982,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/virtualNetworkGateway.json index 2a9a64baee01..24bc9ee8cb3a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/virtualNetworkGateway.json @@ -754,7 +754,7 @@ "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.", + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", "schema": { "$ref": "#/definitions/VpnClientIPsecParameters" } @@ -1717,7 +1717,7 @@ "$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." @@ -2058,7 +2058,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2325,7 +2325,7 @@ "ECP384", "PFS24", "PFS14", - "PFSMM" + "PFSMM" ], "x-ms-enum": { "name": "PfsGroup", @@ -2474,7 +2474,7 @@ "pfsGroup" ], "description": "An IPSec parameters for a virtual network gateway P2S connection." - }, + }, "LocalNetworkGatewayPropertiesFormat": { "properties": { "localNetworkAddressSpace": { @@ -2572,7 +2572,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", 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 index 15d374aa163a..e4f287d8f7de 100644 --- 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 @@ -1769,7 +1769,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size for WAF." + "description": "Maximum request body size for WAF." } }, "required": [ 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 index 3c088eaf7d63..6001a93eae9c 100644 --- 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 @@ -1,273 +1,273 @@ -{ +{ "swagger":"2.0", - "info":{ + "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":[ + "schemes":[ "https" ], - "consumes":[ + "consumes":[ "application/json" ], - "produces":[ + "produces":[ "application/json" ], - "security":[ - { - "azure_auth":[ + "security":[ + { + "azure_auth":[ "user_impersonation" ] } ], - "securityDefinitions":{ - "azure_auth":{ + "securityDefinitions":{ + "azure_auth":{ "type":"oauth2", "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", "flow":"implicit", "description":"Azure Active Directory OAuth2 Flow", - "scopes":{ + "scopes":{ "user_impersonation":"impersonate your user account" } } }, - "paths":{ - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ - "delete":{ - "tags":[ + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ + "delete":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Delete", "description":"Deletes the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "202":{ + "responses":{ + "202":{ "description":"Accepted and the operation will complete asynchronously." }, - "204":{ + "204":{ "description":"Request successful. Resource with the specified name does not exist" }, - "200":{ + "200":{ "description":"Delete successful." } }, - "x-ms-examples":{ - "Delete Azure Firewall":{ + "x-ms-examples":{ + "Delete Azure Firewall":{ "$ref":"./examples/AzureFirewallDelete.json" } }, "x-ms-long-running-operation":true }, - "get":{ - "tags":[ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Get", "description":"Gets the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Request successful. The operation returns a AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Get Azure Firewall":{ + "x-ms-examples":{ + "Get Azure Firewall":{ "$ref":"./examples/AzureFirewallGet.json" } } }, - "put":{ - "tags":[ + "put":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_CreateOrUpdate", "description":"Creates or updates the specified Azure Firewall.", - "parameters":[ - { + "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":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" }, "description":"Parameters supplied to the create or update Azure Firewall operation." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "201":{ + "responses":{ + "201":{ "description":"Create successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } }, - "200":{ + "200":{ "description":"Update successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Create Azure Firewall":{ + "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":[ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_List", "description":"Lists all Azure Firewalls in a resource group.", - "parameters":[ - { + "parameters":[ + { "name":"resourceGroupName", "in":"path", "required":true, "type":"string", "description":"The name of the resource group." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given resource group":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given resource group":{ "$ref":"./examples/AzureFirewallListByResourceGroup.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ - "get":{ - "tags":[ + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_ListAll", "description":"Gets all the Azure Firewalls in a subscription.", - "parameters":[ - { + "parameters":[ + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given subscription":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given subscription":{ "$ref":"./examples/AzureFirewallListBySubscription.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } } }, - "definitions":{ - "AzureFirewallIPConfigurationPropertiesFormat":{ - "properties":{ + "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":{ + "subnet":{ "$ref":"./network.json#/definitions/SubResource", "description":"Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'." }, - "internalPublicIpAddress":{ + "internalPublicIpAddress":{ "$ref":"./network.json#/definitions/SubResource", "description":"Reference of the PublicIP resource. This field is a mandatory input." }, @@ -275,103 +275,103 @@ "$ref": "./network.json#/definitions/SubResource", "description": "Reference of the PublicIP resource. This field is populated in the output." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of IP configuration of an Azure Firewall." }, - "AzureFirewallIPConfiguration":{ - "properties":{ - "properties":{ + "AzureFirewallIPConfiguration":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "description":"A unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"IP configuration of an Azure Firewall." }, - "AzureFirewallPropertiesFormat":{ - "properties":{ - "applicationRuleCollections":{ + "AzureFirewallPropertiesFormat":{ + "properties":{ + "applicationRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleCollection" }, "description":"Collection of application rule collections used by a Azure Firewall." }, - "networkRuleCollections":{ + "networkRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleCollection" }, "description":"Collection of network rule collections used by a Azure Firewall." }, - "ipConfigurations":{ + "ipConfigurations":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallIPConfiguration" }, "description":"IP configuration of the Azure Firewall resource." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the Azure Firewall." }, - "AzureFirewall":{ - "properties":{ - "properties":{ + "AzureFirewall":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallPropertiesFormat" }, - "etag":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/Resource" } ], "description":"Azure Firewall resource" }, - "AzureFirewallListResult":{ - "properties":{ - "value":{ + "AzureFirewallListResult":{ + "properties":{ + "value":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewall" }, "description":"List of a Azure Firewalls in a resource group." }, - "nextLink":{ + "nextLink":{ "type":"string", "description":"URL to get the next set of results." } }, "description":"Response for ListAzureFirewalls API service call." }, - "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -380,54 +380,54 @@ "exclusiveMinimum":false, "description":"Priority of the application rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRule" }, "description":"Collection of rules used by a application rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the application rule collection." }, - "AzureFirewallApplicationRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallApplicationRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Application rule collection resource" }, - "AzureFirewallApplicationRuleProtocol":{ - "properties":{ - "protocolType":{ + "AzureFirewallApplicationRuleProtocol":{ + "properties":{ + "protocolType":{ "description":"Protocol type", "$ref":"#/definitions/AzureFirewallApplicationRuleProtocolType" }, - "port":{ + "port":{ "type":"integer", "format":"int32", "maximum":64000, @@ -439,43 +439,43 @@ }, "description":"Properties of the application rule protocol." }, - "AzureFirewallApplicationRule":{ - "properties":{ - "name":{ + "AzureFirewallApplicationRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the application rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleProtocol" }, "description":"Array of ApplicationRuleProtocols." }, - "targetUrls":{ + "targetUrls":{ "type":"array", "description":"List of URLs for this rule.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of an application rule." }, - "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -484,146 +484,146 @@ "exclusiveMinimum":false, "description":"Priority of the network rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRule" }, "description":"Collection of rules used by a network rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the network rule collection." }, - "AzureFirewallNetworkRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNetworkRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Network rule collection resource" }, - "AzureFirewallNetworkRule":{ - "properties":{ - "name":{ + "AzureFirewallNetworkRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the network rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of the network rule." }, - "AzureFirewallRCAction":{ - "properties":{ - "type":{ + "AzureFirewallRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallRCActionType" } }, "description":"Properties of the AzureFirewallRCAction." }, - "AzureFirewallRCActionType":{ + "AzureFirewallRCActionType":{ "type":"string", "description":"The action type of a rule collection", - "enum":[ + "enum":[ "Allow", "Deny" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallRCActionType", "modelAsString":true } }, - "ProvisioningState":{ + "ProvisioningState":{ "type":"string", "readOnly":true, - "description":"The current provisisoning state.", - "enum":[ + "description":"The current provisioning state.", + "enum":[ "Succeeded", "Updating", "Deleting", "Failed" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"ProvisioningState", "modelAsString":true } }, - "AzureFirewallNetworkRuleProtocol":{ + "AzureFirewallNetworkRuleProtocol":{ "type":"string", "description":"The protocol of a Network Rule resource", - "enum":[ + "enum":[ "TCP", "UDP", "Any", - "ICMP" + "ICMP" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNetworkRuleProtocol", "modelAsString":true } }, - "AzureFirewallApplicationRuleProtocolType":{ + "AzureFirewallApplicationRuleProtocolType":{ "type":"string", "description":"The protocol type of a Application Rule resource", - "enum":[ + "enum":[ "Http", "Https" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallApplicationRuleProtocolType", "modelAsString":true } 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 index 51f604de4e97..2ed23a695730 100644 --- 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 @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } @@ -91,7 +91,7 @@ ], "responses": { "200": { - "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } 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 index 1b23ac8452f1..2ef359995870 100644 --- 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 @@ -860,14 +860,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -882,14 +882,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", 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 index b90e1fa31ecd..0534b6beb831 100644 --- 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 @@ -628,15 +628,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -654,7 +654,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -705,7 +705,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" 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 index 1628139a0fe3..f456517c8b55 100644 --- 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 @@ -2916,7 +2916,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -3101,7 +3101,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { 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 index fef7c281e292..ac078d5b84c9 100644 --- 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 @@ -752,7 +752,7 @@ "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.", + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", "schema": { "$ref": "#/definitions/VpnClientIPsecParameters" } @@ -803,8 +803,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } - } + "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } + } } }, @@ -1723,7 +1723,7 @@ "$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." @@ -2076,7 +2076,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2348,7 +2348,7 @@ "ECP384", "PFS24", "PFS14", - "PFSMM" + "PFSMM" ], "x-ms-enum": { "name": "PfsGroup", @@ -2497,7 +2497,7 @@ "pfsGroup" ], "description": "An IPSec parameters for a virtual network gateway P2S connection." - }, + }, "LocalNetworkGatewayPropertiesFormat": { "properties": { "localNetworkAddressSpace": { @@ -2595,7 +2595,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", 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 index a709ebc7fe14..0afbef08c310 100644 --- 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 @@ -328,7 +328,7 @@ "x-ms-examples": { "VpnSiteGet": { "$ref": "./examples/VpnSiteGet.json" } }, - "description": "Retrieves the details of a VPNsite.", + "description": "Retrieves the details of a VPN site.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -2039,7 +2039,7 @@ "ProvisioningState": { "type": "string", "readOnly": true, - "description": "The current provisisoning state.", + "description": "The current provisioning state.", "enum": [ "Succeeded", "Updating", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/applicationGateway.json index 1601823e0af6..a2de5f0f37cd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/applicationGateway.json @@ -1769,7 +1769,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size for WAF." + "description": "Maximum request body size for WAF." } }, "required": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/azureFirewall.json index b71b9bf3f934..056c7b9138eb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/azureFirewall.json @@ -1,273 +1,273 @@ -{ +{ "swagger":"2.0", - "info":{ + "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-06-01" }, "host":"management.azure.com", - "schemes":[ + "schemes":[ "https" ], - "consumes":[ + "consumes":[ "application/json" ], - "produces":[ + "produces":[ "application/json" ], - "security":[ - { - "azure_auth":[ + "security":[ + { + "azure_auth":[ "user_impersonation" ] } ], - "securityDefinitions":{ - "azure_auth":{ + "securityDefinitions":{ + "azure_auth":{ "type":"oauth2", "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", "flow":"implicit", "description":"Azure Active Directory OAuth2 Flow", - "scopes":{ + "scopes":{ "user_impersonation":"impersonate your user account" } } }, - "paths":{ - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ - "delete":{ - "tags":[ + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ + "delete":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Delete", "description":"Deletes the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "202":{ + "responses":{ + "202":{ "description":"Accepted and the operation will complete asynchronously." }, - "204":{ + "204":{ "description":"Request successful. Resource with the specified name does not exist" }, - "200":{ + "200":{ "description":"Delete successful." } }, - "x-ms-examples":{ - "Delete Azure Firewall":{ + "x-ms-examples":{ + "Delete Azure Firewall":{ "$ref":"./examples/AzureFirewallDelete.json" } }, "x-ms-long-running-operation":true }, - "get":{ - "tags":[ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Get", "description":"Gets the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Request successful. The operation returns a AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Get Azure Firewall":{ + "x-ms-examples":{ + "Get Azure Firewall":{ "$ref":"./examples/AzureFirewallGet.json" } } }, - "put":{ - "tags":[ + "put":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_CreateOrUpdate", "description":"Creates or updates the specified Azure Firewall.", - "parameters":[ - { + "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":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" }, "description":"Parameters supplied to the create or update Azure Firewall operation." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "201":{ + "responses":{ + "201":{ "description":"Create successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } }, - "200":{ + "200":{ "description":"Update successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Create Azure Firewall":{ + "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":[ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_List", "description":"Lists all Azure Firewalls in a resource group.", - "parameters":[ - { + "parameters":[ + { "name":"resourceGroupName", "in":"path", "required":true, "type":"string", "description":"The name of the resource group." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given resource group":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given resource group":{ "$ref":"./examples/AzureFirewallListByResourceGroup.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ - "get":{ - "tags":[ + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_ListAll", "description":"Gets all the Azure Firewalls in a subscription.", - "parameters":[ - { + "parameters":[ + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given subscription":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given subscription":{ "$ref":"./examples/AzureFirewallListBySubscription.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } } }, - "definitions":{ - "AzureFirewallIPConfigurationPropertiesFormat":{ - "properties":{ + "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":{ + "subnet":{ "$ref":"./network.json#/definitions/SubResource", "description":"Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'." }, - "internalPublicIpAddress":{ + "internalPublicIpAddress":{ "$ref":"./network.json#/definitions/SubResource", "description":"Reference of the PublicIP resource. This field is a mandatory input." }, @@ -275,103 +275,103 @@ "$ref": "./network.json#/definitions/SubResource", "description": "Reference of the PublicIP resource. This field is populated in the output." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of IP configuration of an Azure Firewall." }, - "AzureFirewallIPConfiguration":{ - "properties":{ - "properties":{ + "AzureFirewallIPConfiguration":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "description":"A unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"IP configuration of an Azure Firewall." }, - "AzureFirewallPropertiesFormat":{ - "properties":{ - "applicationRuleCollections":{ + "AzureFirewallPropertiesFormat":{ + "properties":{ + "applicationRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleCollection" }, "description":"Collection of application rule collections used by a Azure Firewall." }, - "networkRuleCollections":{ + "networkRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleCollection" }, "description":"Collection of network rule collections used by a Azure Firewall." }, - "ipConfigurations":{ + "ipConfigurations":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallIPConfiguration" }, "description":"IP configuration of the Azure Firewall resource." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the Azure Firewall." }, - "AzureFirewall":{ - "properties":{ - "properties":{ + "AzureFirewall":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallPropertiesFormat" }, - "etag":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/Resource" } ], "description":"Azure Firewall resource" }, - "AzureFirewallListResult":{ - "properties":{ - "value":{ + "AzureFirewallListResult":{ + "properties":{ + "value":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewall" }, "description":"List of a Azure Firewalls in a resource group." }, - "nextLink":{ + "nextLink":{ "type":"string", "description":"URL to get the next set of results." } }, "description":"Response for ListAzureFirewalls API service call." }, - "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -380,54 +380,54 @@ "exclusiveMinimum":false, "description":"Priority of the application rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRule" }, "description":"Collection of rules used by a application rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the application rule collection." }, - "AzureFirewallApplicationRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallApplicationRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Application rule collection resource" }, - "AzureFirewallApplicationRuleProtocol":{ - "properties":{ - "protocolType":{ + "AzureFirewallApplicationRuleProtocol":{ + "properties":{ + "protocolType":{ "description":"Protocol type", "$ref":"#/definitions/AzureFirewallApplicationRuleProtocolType" }, - "port":{ + "port":{ "type":"integer", "format":"int32", "maximum":64000, @@ -439,43 +439,43 @@ }, "description":"Properties of the application rule protocol." }, - "AzureFirewallApplicationRule":{ - "properties":{ - "name":{ + "AzureFirewallApplicationRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the application rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleProtocol" }, "description":"Array of ApplicationRuleProtocols." }, - "targetUrls":{ + "targetUrls":{ "type":"array", "description":"List of URLs for this rule.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of an application rule." }, - "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -484,146 +484,146 @@ "exclusiveMinimum":false, "description":"Priority of the network rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRule" }, "description":"Collection of rules used by a network rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the network rule collection." }, - "AzureFirewallNetworkRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNetworkRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Network rule collection resource" }, - "AzureFirewallNetworkRule":{ - "properties":{ - "name":{ + "AzureFirewallNetworkRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the network rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of the network rule." }, - "AzureFirewallRCAction":{ - "properties":{ - "type":{ + "AzureFirewallRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallRCActionType" } }, "description":"Properties of the AzureFirewallRCAction." }, - "AzureFirewallRCActionType":{ + "AzureFirewallRCActionType":{ "type":"string", "description":"The action type of a rule collection", - "enum":[ + "enum":[ "Allow", "Deny" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallRCActionType", "modelAsString":true } }, - "ProvisioningState":{ + "ProvisioningState":{ "type":"string", "readOnly":true, - "description":"The current provisisoning state.", - "enum":[ + "description":"The current provisioning state.", + "enum":[ "Succeeded", "Updating", "Deleting", "Failed" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"ProvisioningState", "modelAsString":true } }, - "AzureFirewallNetworkRuleProtocol":{ + "AzureFirewallNetworkRuleProtocol":{ "type":"string", "description":"The protocol of a Network Rule resource", - "enum":[ + "enum":[ "TCP", "UDP", "Any", "ICMP" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNetworkRuleProtocol", "modelAsString":true } }, - "AzureFirewallApplicationRuleProtocolType":{ + "AzureFirewallApplicationRuleProtocolType":{ "type":"string", "description":"The protocol type of a Application Rule resource", - "enum":[ + "enum":[ "Http", "Https" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallApplicationRuleProtocolType", "modelAsString":true } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/expressRouteCrossConnection.json index 662c14d9e7dd..85ddf6f82e4f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/expressRouteCrossConnection.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/expressRouteCrossConnection.json @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } @@ -91,7 +91,7 @@ ], "responses": { "200": { - "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkInterface.json index d2b284c3e6e4..c780641cb1ab 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkInterface.json @@ -860,14 +860,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -882,14 +882,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkSecurityGroup.json index ba328c13326f..230e4e2ea201 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkSecurityGroup.json @@ -628,15 +628,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -654,7 +654,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -705,7 +705,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkWatcher.json index 53c78cec97ca..9a5b9087c2ec 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/networkWatcher.json @@ -1785,8 +1785,8 @@ ], "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, "description": "Get network configuration diagnostic.", "parameters": [ @@ -1822,7 +1822,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns the result of network condifuration diagnostic.", + "description": "Request successful. The operation returns the result of network configuration diagnostic.", "schema": { "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" } @@ -3172,7 +3172,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -3357,7 +3357,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { @@ -3484,7 +3484,7 @@ }, "destinationPort": { "type": "string", - "description": "Traffice destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." + "description": "Traffic destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/virtualNetworkGateway.json index 611c1298e30d..d3c5fc73173b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/virtualNetworkGateway.json @@ -795,7 +795,7 @@ "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.", + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", "schema": { "$ref": "#/definitions/VpnClientIPsecParameters" } @@ -846,8 +846,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } - } + "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } + } } }, @@ -1766,7 +1766,7 @@ "$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." @@ -2119,7 +2119,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2391,7 +2391,7 @@ "ECP384", "PFS24", "PFS14", - "PFSMM" + "PFSMM" ], "x-ms-enum": { "name": "PfsGroup", @@ -2540,7 +2540,7 @@ "pfsGroup" ], "description": "An IPSec parameters for a virtual network gateway P2S connection." - }, + }, "LocalNetworkGatewayPropertiesFormat": { "properties": { "localNetworkAddressSpace": { @@ -2638,7 +2638,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/virtualWan.json index e3fe7ca579ad..0b61382b6550 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/virtualWan.json @@ -328,7 +328,7 @@ "x-ms-examples": { "VpnSiteGet": { "$ref": "./examples/VpnSiteGet.json" } }, - "description": "Retrieves the details of a VPNsite.", + "description": "Retrieves the details of a VPN site.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -2039,7 +2039,7 @@ "ProvisioningState": { "type": "string", "readOnly": true, - "description": "The current provisisoning state.", + "description": "The current provisioning state.", "enum": [ "Succeeded", "Updating", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/applicationGateway.json index 378e3a42a1b1..9c4b9392e145 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/applicationGateway.json @@ -1769,7 +1769,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size for WAF." + "description": "Maximum request body size for WAF." } }, "required": [ diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/azureFirewall.json index d412bcf73479..076fd654040b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/azureFirewall.json @@ -1,273 +1,273 @@ -{ +{ "swagger":"2.0", - "info":{ + "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-07-01" }, "host":"management.azure.com", - "schemes":[ + "schemes":[ "https" ], - "consumes":[ + "consumes":[ "application/json" ], - "produces":[ + "produces":[ "application/json" ], - "security":[ - { - "azure_auth":[ + "security":[ + { + "azure_auth":[ "user_impersonation" ] } ], - "securityDefinitions":{ - "azure_auth":{ + "securityDefinitions":{ + "azure_auth":{ "type":"oauth2", "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", "flow":"implicit", "description":"Azure Active Directory OAuth2 Flow", - "scopes":{ + "scopes":{ "user_impersonation":"impersonate your user account" } } }, - "paths":{ - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ - "delete":{ - "tags":[ + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ + "delete":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Delete", "description":"Deletes the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "202":{ + "responses":{ + "202":{ "description":"Accepted and the operation will complete asynchronously." }, - "204":{ + "204":{ "description":"Request successful. Resource with the specified name does not exist" }, - "200":{ + "200":{ "description":"Delete successful." } }, - "x-ms-examples":{ - "Delete Azure Firewall":{ + "x-ms-examples":{ + "Delete Azure Firewall":{ "$ref":"./examples/AzureFirewallDelete.json" } }, "x-ms-long-running-operation":true }, - "get":{ - "tags":[ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Get", "description":"Gets the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Request successful. The operation returns a AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Get Azure Firewall":{ + "x-ms-examples":{ + "Get Azure Firewall":{ "$ref":"./examples/AzureFirewallGet.json" } } }, - "put":{ - "tags":[ + "put":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_CreateOrUpdate", "description":"Creates or updates the specified Azure Firewall.", - "parameters":[ - { + "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":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" }, "description":"Parameters supplied to the create or update Azure Firewall operation." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "201":{ + "responses":{ + "201":{ "description":"Create successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } }, - "200":{ + "200":{ "description":"Update successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Create Azure Firewall":{ + "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":[ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_List", "description":"Lists all Azure Firewalls in a resource group.", - "parameters":[ - { + "parameters":[ + { "name":"resourceGroupName", "in":"path", "required":true, "type":"string", "description":"The name of the resource group." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given resource group":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given resource group":{ "$ref":"./examples/AzureFirewallListByResourceGroup.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ - "get":{ - "tags":[ + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_ListAll", "description":"Gets all the Azure Firewalls in a subscription.", - "parameters":[ - { + "parameters":[ + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given subscription":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given subscription":{ "$ref":"./examples/AzureFirewallListBySubscription.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } } }, - "definitions":{ - "AzureFirewallIPConfigurationPropertiesFormat":{ - "properties":{ + "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":{ + "subnet":{ "$ref":"./network.json#/definitions/SubResource", "description":"Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'." }, - "internalPublicIpAddress":{ + "internalPublicIpAddress":{ "$ref":"./network.json#/definitions/SubResource", "description":"Reference of the PublicIP resource. This field is a mandatory input." }, @@ -275,103 +275,103 @@ "$ref": "./network.json#/definitions/SubResource", "description": "Reference of the PublicIP resource. This field is populated in the output." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of IP configuration of an Azure Firewall." }, - "AzureFirewallIPConfiguration":{ - "properties":{ - "properties":{ + "AzureFirewallIPConfiguration":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "description":"A unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"IP configuration of an Azure Firewall." }, - "AzureFirewallPropertiesFormat":{ - "properties":{ - "applicationRuleCollections":{ + "AzureFirewallPropertiesFormat":{ + "properties":{ + "applicationRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleCollection" }, "description":"Collection of application rule collections used by a Azure Firewall." }, - "networkRuleCollections":{ + "networkRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleCollection" }, "description":"Collection of network rule collections used by a Azure Firewall." }, - "ipConfigurations":{ + "ipConfigurations":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallIPConfiguration" }, "description":"IP configuration of the Azure Firewall resource." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the Azure Firewall." }, - "AzureFirewall":{ - "properties":{ - "properties":{ + "AzureFirewall":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallPropertiesFormat" }, - "etag":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/Resource" } ], "description":"Azure Firewall resource" }, - "AzureFirewallListResult":{ - "properties":{ - "value":{ + "AzureFirewallListResult":{ + "properties":{ + "value":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewall" }, "description":"List of a Azure Firewalls in a resource group." }, - "nextLink":{ + "nextLink":{ "type":"string", "description":"URL to get the next set of results." } }, "description":"Response for ListAzureFirewalls API service call." }, - "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -380,54 +380,54 @@ "exclusiveMinimum":false, "description":"Priority of the application rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRule" }, "description":"Collection of rules used by a application rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the application rule collection." }, - "AzureFirewallApplicationRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallApplicationRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Application rule collection resource" }, - "AzureFirewallApplicationRuleProtocol":{ - "properties":{ - "protocolType":{ + "AzureFirewallApplicationRuleProtocol":{ + "properties":{ + "protocolType":{ "description":"Protocol type", "$ref":"#/definitions/AzureFirewallApplicationRuleProtocolType" }, - "port":{ + "port":{ "type":"integer", "format":"int32", "maximum":64000, @@ -439,43 +439,43 @@ }, "description":"Properties of the application rule protocol." }, - "AzureFirewallApplicationRule":{ - "properties":{ - "name":{ + "AzureFirewallApplicationRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the application rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleProtocol" }, "description":"Array of ApplicationRuleProtocols." }, - "targetUrls":{ + "targetUrls":{ "type":"array", "description":"List of URLs for this rule.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of an application rule." }, - "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -484,146 +484,146 @@ "exclusiveMinimum":false, "description":"Priority of the network rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRule" }, "description":"Collection of rules used by a network rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the network rule collection." }, - "AzureFirewallNetworkRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNetworkRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Network rule collection resource" }, - "AzureFirewallNetworkRule":{ - "properties":{ - "name":{ + "AzureFirewallNetworkRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the network rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of the network rule." }, - "AzureFirewallRCAction":{ - "properties":{ - "type":{ + "AzureFirewallRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallRCActionType" } }, "description":"Properties of the AzureFirewallRCAction." }, - "AzureFirewallRCActionType":{ + "AzureFirewallRCActionType":{ "type":"string", "description":"The action type of a rule collection", - "enum":[ + "enum":[ "Allow", "Deny" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallRCActionType", "modelAsString":true } }, - "ProvisioningState":{ + "ProvisioningState":{ "type":"string", "readOnly":true, - "description":"The current provisisoning state.", - "enum":[ + "description":"The current provisioning state.", + "enum":[ "Succeeded", "Updating", "Deleting", "Failed" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"ProvisioningState", "modelAsString":true } }, - "AzureFirewallNetworkRuleProtocol":{ + "AzureFirewallNetworkRuleProtocol":{ "type":"string", "description":"The protocol of a Network Rule resource", - "enum":[ + "enum":[ "TCP", "UDP", "Any", "ICMP" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNetworkRuleProtocol", "modelAsString":true } }, - "AzureFirewallApplicationRuleProtocolType":{ + "AzureFirewallApplicationRuleProtocolType":{ "type":"string", "description":"The protocol type of a Application Rule resource", - "enum":[ + "enum":[ "Http", "Https" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallApplicationRuleProtocolType", "modelAsString":true } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/expressRouteCrossConnection.json index 4ed4b0d6110a..700a67dcd974 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/expressRouteCrossConnection.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/expressRouteCrossConnection.json @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } @@ -91,7 +91,7 @@ ], "responses": { "200": { - "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkInterface.json index 96f386de7151..c4a34b983749 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkInterface.json @@ -860,14 +860,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -882,14 +882,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkSecurityGroup.json index c7b339b37cb7..38ff8af793c7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkSecurityGroup.json @@ -628,15 +628,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -654,7 +654,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -705,7 +705,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkWatcher.json index 796bd3bb8571..ce05c2657890 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/networkWatcher.json @@ -1785,8 +1785,8 @@ ], "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, "description": "Get network configuration diagnostic.", "parameters": [ @@ -1822,7 +1822,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns the result of network condifuration diagnostic.", + "description": "Request successful. The operation returns the result of network configuration diagnostic.", "schema": { "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" } @@ -3172,7 +3172,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -3357,7 +3357,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { @@ -3484,7 +3484,7 @@ }, "destinationPort": { "type": "string", - "description": "Traffice destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." + "description": "Traffic destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/publicIpPrefix.json index 187cb44761c1..d1d7432fee7e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/publicIpPrefix.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/publicIpPrefix.json @@ -98,7 +98,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the PublicIPPrefx." + "description": "The name of the Public IP Prefix." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/serviceEndpointPolicy.json index 3c70c89b0993..7aba5d5f920e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/serviceEndpointPolicy.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/serviceEndpointPolicy.json @@ -75,7 +75,7 @@ } }, "x-ms-examples": { - "Delete service endpoint Policys": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } + "Delete service endpoint Policy": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } }, "x-ms-long-running-operation": true }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/virtualNetworkGateway.json index d6ff7a5311f7..3a1356de3d24 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/virtualNetworkGateway.json @@ -752,7 +752,7 @@ "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.", + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", "schema": { "$ref": "#/definitions/VpnClientIPsecParameters" } @@ -803,8 +803,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } - } + "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } + } } }, @@ -1723,7 +1723,7 @@ "$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." @@ -2076,7 +2076,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2352,7 +2352,7 @@ "ECP384", "PFS24", "PFS14", - "PFSMM" + "PFSMM" ], "x-ms-enum": { "name": "PfsGroup", @@ -2501,7 +2501,7 @@ "pfsGroup" ], "description": "An IPSec parameters for a virtual network gateway P2S connection." - }, + }, "LocalNetworkGatewayPropertiesFormat": { "properties": { "localNetworkAddressSpace": { @@ -2599,7 +2599,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/virtualWan.json index d6f06a25479e..ea5bbb79d292 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/virtualWan.json @@ -328,7 +328,7 @@ "x-ms-examples": { "VpnSiteGet": { "$ref": "./examples/VpnSiteGet.json" } }, - "description": "Retrieves the details of a VPNsite.", + "description": "Retrieves the details of a VPN site.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -2039,7 +2039,7 @@ "ProvisioningState": { "type": "string", "readOnly": true, - "description": "The current provisisoning state.", + "description": "The current provisioning state.", "enum": [ "Succeeded", "Updating", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json index 77c14e39c946..3e848b33dfb8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json @@ -1840,7 +1840,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size for WAF." + "description": "Maximum request body size for WAF." }, "maxRequestBodySizeInKb": { "type": "integer", @@ -1849,7 +1849,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size in Kb for WAF." + "description": "Maximum request body size in Kb for WAF." }, "fileUploadLimitInMb": { "type": "integer", @@ -1858,7 +1858,7 @@ "exclusiveMaximum": false, "minimum": 0, "exclusiveMinimum": false, - "description": "Maxium file upload size in Mb for WAF." + "description": "Maximum file upload size in Mb for WAF." }, "exclusions": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/azureFirewall.json index 0fac88e45080..762df12354df 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/azureFirewall.json @@ -1,264 +1,264 @@ -{ +{ "swagger":"2.0", - "info":{ + "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-08-01" }, "host":"management.azure.com", - "schemes":[ + "schemes":[ "https" ], - "consumes":[ + "consumes":[ "application/json" ], - "produces":[ + "produces":[ "application/json" ], - "security":[ - { - "azure_auth":[ + "security":[ + { + "azure_auth":[ "user_impersonation" ] } ], - "securityDefinitions":{ - "azure_auth":{ + "securityDefinitions":{ + "azure_auth":{ "type":"oauth2", "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", "flow":"implicit", "description":"Azure Active Directory OAuth2 Flow", - "scopes":{ + "scopes":{ "user_impersonation":"impersonate your user account" } } }, - "paths":{ - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ - "delete":{ - "tags":[ + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ + "delete":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Delete", "description":"Deletes the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "202":{ + "responses":{ + "202":{ "description":"Accepted and the operation will complete asynchronously." }, - "204":{ + "204":{ "description":"Request successful. Resource with the specified name does not exist" }, - "200":{ + "200":{ "description":"Delete successful." } }, - "x-ms-examples":{ - "Delete Azure Firewall":{ + "x-ms-examples":{ + "Delete Azure Firewall":{ "$ref":"./examples/AzureFirewallDelete.json" } }, "x-ms-long-running-operation":true }, - "get":{ - "tags":[ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Get", "description":"Gets the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Request successful. The operation returns an AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Get Azure Firewall":{ + "x-ms-examples":{ + "Get Azure Firewall":{ "$ref":"./examples/AzureFirewallGet.json" } } }, - "put":{ - "tags":[ + "put":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_CreateOrUpdate", "description":"Creates or updates the specified Azure Firewall.", - "parameters":[ - { + "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":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" }, "description":"Parameters supplied to the create or update Azure Firewall operation." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "201":{ + "responses":{ + "201":{ "description":"Create successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } }, - "200":{ + "200":{ "description":"Update successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Create Azure Firewall":{ + "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":[ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_List", "description":"Lists all Azure Firewalls in a resource group.", - "parameters":[ - { + "parameters":[ + { "name":"resourceGroupName", "in":"path", "required":true, "type":"string", "description":"The name of the resource group." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given resource group":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given resource group":{ "$ref":"./examples/AzureFirewallListByResourceGroup.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ - "get":{ - "tags":[ + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_ListAll", "description":"Gets all the Azure Firewalls in a subscription.", - "parameters":[ - { + "parameters":[ + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given subscription":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given subscription":{ "$ref":"./examples/AzureFirewallListBySubscription.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } } }, - "definitions":{ - "AzureFirewallIPConfigurationPropertiesFormat":{ - "properties":{ + "definitions":{ + "AzureFirewallIPConfigurationPropertiesFormat":{ + "properties":{ "privateIPAddress": { "type": "string", "description": "The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes." @@ -271,111 +271,111 @@ "$ref": "./network.json#/definitions/SubResource", "description": "Reference of the PublicIP resource. This field is a mandatory input if subnet is not null." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of IP configuration of an Azure Firewall." }, - "AzureFirewallIPConfiguration":{ - "properties":{ - "properties":{ + "AzureFirewallIPConfiguration":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly": true, "description":"A unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"IP configuration of an Azure Firewall." }, - "AzureFirewallPropertiesFormat":{ - "properties":{ - "applicationRuleCollections":{ + "AzureFirewallPropertiesFormat":{ + "properties":{ + "applicationRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleCollection" }, "description":"Collection of application rule collections used by Azure Firewall." }, - "natRuleCollections":{ + "natRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNatRuleCollection" }, "description":"Collection of NAT rule collections used by Azure Firewall." }, - "networkRuleCollections":{ + "networkRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleCollection" }, "description":"Collection of network rule collections used by Azure Firewall." }, - "ipConfigurations":{ + "ipConfigurations":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallIPConfiguration" }, "description":"IP configuration of the Azure Firewall resource." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the Azure Firewall." }, - "AzureFirewall":{ - "properties":{ - "properties":{ + "AzureFirewall":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallPropertiesFormat" }, - "etag":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/Resource" } ], "description":"Azure Firewall resource" }, - "AzureFirewallListResult":{ - "properties":{ - "value":{ + "AzureFirewallListResult":{ + "properties":{ + "value":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewall" }, "description":"List of Azure Firewalls in a resource group." }, - "nextLink":{ + "nextLink":{ "type":"string", "description":"URL to get the next set of results." } }, "description":"Response for ListAzureFirewalls API service call." }, - "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -384,54 +384,54 @@ "exclusiveMinimum":false, "description":"Priority of the application rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRule" }, "description":"Collection of rules used by a application rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the application rule collection." }, - "AzureFirewallApplicationRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallApplicationRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Application rule collection resource" }, - "AzureFirewallApplicationRuleProtocol":{ - "properties":{ - "protocolType":{ + "AzureFirewallApplicationRuleProtocol":{ + "properties":{ + "protocolType":{ "description":"Protocol type", "$ref":"#/definitions/AzureFirewallApplicationRuleProtocolType" }, - "port":{ + "port":{ "type":"integer", "format":"int32", "maximum":64000, @@ -443,41 +443,41 @@ }, "description":"Properties of the application rule protocol." }, - "AzureFirewallApplicationRule":{ - "properties":{ - "name":{ + "AzureFirewallApplicationRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the application rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleProtocol" }, "description":"Array of ApplicationRuleProtocols." }, - "targetFqdns":{ + "targetFqdns":{ "type":"array", "description":"List of FQDNs for this rule.", - "items":{ + "items":{ "type":"string" } }, "fqdnTags":{ "type":"array", "description":"List of FQDN Tags for this rule.", - "items":{ + "items":{ "type":"string" } } @@ -485,8 +485,8 @@ "description":"Properties of an application rule." }, "AzureFirewallNatRuleCollectionProperties": { - "properties":{ - "priority":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -495,120 +495,120 @@ "exclusiveMinimum":false, "description":"Priority of the NAT rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallNatRCAction", "description":"The action type of a NAT rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNatRule" }, "description":"Collection of rules used by a NAT rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the NAT rule collection." }, - "AzureFirewallNatRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNatRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNatRuleCollectionProperties" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"NAT rule collection resource" }, - "AzureFirewallNatRule":{ - "properties":{ - "name":{ + "AzureFirewallNatRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the NAT rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule." }, - "translatedAddress":{ + "translatedAddress":{ "type":"string", "description":"The translated address for this NAT rule." }, - "translatedPort":{ + "translatedPort":{ "type":"string", "description":"The translated port for this NAT rule." } }, "description":"Properties of a NAT rule." }, - "AzureFirewallNatRCAction":{ - "properties":{ - "type":{ + "AzureFirewallNatRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallNatRCActionType" } }, "description":"AzureFirewall NAT Rule Collection Action." }, - "AzureFirewallNatRCActionType":{ + "AzureFirewallNatRCActionType":{ "type":"string", "description":"The action type of a NAT rule collection", - "enum":[ + "enum":[ "Snat", "Dnat" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNatRCActionType", "modelAsString":true } }, - "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -617,146 +617,146 @@ "exclusiveMinimum":false, "description":"Priority of the network rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRule" }, "description":"Collection of rules used by a network rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the network rule collection." }, - "AzureFirewallNetworkRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNetworkRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Network rule collection resource" }, - "AzureFirewallNetworkRule":{ - "properties":{ - "name":{ + "AzureFirewallNetworkRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the network rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of the network rule." }, - "AzureFirewallRCAction":{ - "properties":{ - "type":{ + "AzureFirewallRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallRCActionType" } }, "description":"Properties of the AzureFirewallRCAction." }, - "AzureFirewallRCActionType":{ + "AzureFirewallRCActionType":{ "type":"string", "description":"The action type of a rule collection", - "enum":[ + "enum":[ "Allow", "Deny" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallRCActionType", "modelAsString":true } }, - "ProvisioningState":{ + "ProvisioningState":{ "type":"string", "readOnly":true, - "description":"The current provisisoning state.", - "enum":[ + "description":"The current provisioning state.", + "enum":[ "Succeeded", "Updating", "Deleting", "Failed" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"ProvisioningState", "modelAsString":true } }, - "AzureFirewallNetworkRuleProtocol":{ + "AzureFirewallNetworkRuleProtocol":{ "type":"string", "description":"The protocol of a Network Rule resource", - "enum":[ + "enum":[ "TCP", "UDP", "Any", "ICMP" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNetworkRuleProtocol", "modelAsString":true } }, - "AzureFirewallApplicationRuleProtocolType":{ + "AzureFirewallApplicationRuleProtocolType":{ "type":"string", "description":"The protocol type of a Application Rule resource", - "enum":[ + "enum":[ "Http", "Https" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallApplicationRuleProtocolType", "modelAsString":true } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/InterfaceEndpointCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/InterfaceEndpointCreate.json index dfbdbe5a6c66..a863513ba4e7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/InterfaceEndpointCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/InterfaceEndpointCreate.json @@ -24,7 +24,7 @@ "location" : "eastus", "properties" : { "fqdn": "uniqueIdentifier.fqdn.windows.net", - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "owner": "User", "endpointService": { "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationCreate.json index 682a631a10f5..43e6fa35d3c8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationCreate.json @@ -24,7 +24,7 @@ "virtualNetworkTap": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, - "provisioningState": "Succeded" + "provisioningState": "Succeeded" } } }, @@ -38,7 +38,7 @@ "virtualNetworkTap": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, - "provisioningState": "Succeded" + "provisioningState": "Succeeded" } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationGet.json index 466c86aa4189..b64217ddc00e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationGet.json @@ -18,7 +18,7 @@ "virtualNetworkTap": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, - "provisioningState": "Succeded" + "provisioningState": "Succeeded" } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationList.json index 7d61efe95663..e5bcbcc67bb8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkInterfaceTapConfigurationList.json @@ -18,7 +18,7 @@ "virtualNetworkTap": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, - "provisioningState": "Succeded" + "provisioningState": "Succeeded" } } ] diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapCreate.json index 9a743f52e7d6..a650f93c551a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapCreate.json @@ -26,7 +26,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { @@ -48,7 +48,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapGet.json index 0621f8f10575..21cb567b75b6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapGet.json @@ -18,7 +18,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapList.json index 6b36cfcc3f9d..c0e71e730fd2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapList.json @@ -19,7 +19,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { @@ -39,7 +39,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapListAll.json index b1987192c0fd..87934e56416d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapListAll.json @@ -18,7 +18,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { @@ -38,7 +38,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapUpdateTags.json index 4a8882e611e8..90014f234f91 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkTapUpdateTags.json @@ -26,7 +26,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "networkInterfaceTapConfigurations": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCrossConnection.json index 8c92b84533cb..045e0bd19e0b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCrossConnection.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCrossConnection.json @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } @@ -91,7 +91,7 @@ ], "responses": { "200": { - "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRoutePort.json index 820d010fcc18..e6200d1b0e7d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRoutePort.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRoutePort.json @@ -40,7 +40,7 @@ "ExpressRoutePortsLocations" ], "operationId": "ExpressRoutePortsLocations_List", - "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retriving a specific peering location.", + "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -670,7 +670,7 @@ "etherType": { "readOnly": true, "type": "string", - "description": "Ethertype of the physical port." + "description": "Ether type of the physical port." }, "allocationDate": { "readOnly": true, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkInterface.json index 3864a66649fe..8c4c3533bf53 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkInterface.json @@ -580,7 +580,7 @@ "description": "Delete successful." } }, - "x-ms-examples": + "x-ms-examples": { "Delete tap configuration": { "$ref": "./examples/NetworkInterfaceTapConfigurationDelete.json" } }, @@ -629,7 +629,7 @@ } } }, - "x-ms-examples": + "x-ms-examples": { "Get Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationGet.json" } } @@ -692,7 +692,7 @@ } } }, - "x-ms-examples": + "x-ms-examples": { "Create Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationCreate.json" } }, @@ -776,7 +776,7 @@ }, "NetworkInterfaceTapConfigurationPropertiesFormat": { "properties": { - "virtualNetworkTap": { + "virtualNetworkTap": { "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap", "description": "The reference of the Virtual Network Tap resource." }, @@ -1158,14 +1158,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -1180,14 +1180,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkProfile.json index 07019ca84e80..76441a3a0386 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkProfile.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkProfile.json @@ -100,7 +100,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the PublicIPPrefx." + "description": "The name of the Public IP Prefix." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -268,7 +268,7 @@ } }, "x-ms-examples": { - "List all network profilees": { + "List all network profiles": { "$ref": "./examples/NetworkProfileListAll.json" } }, @@ -308,7 +308,7 @@ } }, "x-ms-examples": { - "List resource group network profilees": { + "List resource group network profiles": { "$ref": "./examples/NetworkProfileList.json" } }, @@ -391,7 +391,7 @@ }, "container": { "$ref": "#/definitions/Container", - "description": "Reference to the conatinaer to which this container network interface is attached." + "description": "Reference to the container to which this container network interface is attached." }, "ipConfigurations": { "type": "array", @@ -485,13 +485,13 @@ "$ref": "./network.json#/definitions/SubResource" } ], - "description": "Container network interface configruation child resource." + "description": "Container network interface configuration child resource." }, "IPConfigurationProfilePropertiesFormat": { "properties": { "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", - "description": "The reference of the subnet resource to create a contatainer network interface ip configruation." + "description": "The reference of the subnet resource to create a container network interface ip configuration." }, "provisioningState": { "readOnly": true, @@ -499,7 +499,7 @@ "description": "The provisioning state of the resource." } }, - "description": "IP configruation profile properties." + "description": "IP configuration profile properties." }, "IPConfigurationProfile": { "properties": { @@ -555,7 +555,7 @@ "$ref": "#/definitions/ContainerNetworkInterfaceIpConfigurationPropertiesFormat", "description": "Properties of the container network interface IP configuration." }, - "name": { + "name": { "type": "string", "description": "The name of the resource. This name can be used to access the resource." }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkSecurityGroup.json index 7445065294b5..36c03385eddd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkSecurityGroup.json @@ -628,15 +628,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -654,7 +654,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -705,7 +705,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json index 6103a395dcf9..1f87c35965dd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json @@ -1785,8 +1785,8 @@ ], "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, "description": "Get network configuration diagnostic.", "parameters": [ @@ -1822,7 +1822,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns the result of network condifuration diagnostic.", + "description": "Request successful. The operation returns the result of network configuration diagnostic.", "schema": { "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" } @@ -3172,7 +3172,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -3357,7 +3357,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { @@ -3440,7 +3440,7 @@ "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." }, "verbosityLevel": { - "type": "string", + "type": "string", "enum": [ "Normal", "Minimum", @@ -3497,7 +3497,7 @@ }, "destinationPort": { "type": "string", - "description": "Traffice destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." + "description": "Traffic destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/publicIpPrefix.json index ab40cd71d8b3..ab4d50428ebf 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/publicIpPrefix.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/publicIpPrefix.json @@ -98,7 +98,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the PublicIPPrefx." + "description": "The name of the Public IP Prefix." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json index 21c161feee88..5199175f42cc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json @@ -75,7 +75,7 @@ } }, "x-ms-examples": { - "Delete service endpoint Policys": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } + "Delete service endpoint Policy": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } }, "x-ms-long-running-operation": true }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetworkGateway.json index 4f3afd480047..16a2eb99f078 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetworkGateway.json @@ -795,7 +795,7 @@ "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.", + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", "schema": { "$ref": "#/definitions/VpnClientIPsecParameters" } @@ -846,8 +846,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } - } + "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } + } } }, @@ -1766,7 +1766,7 @@ "$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." @@ -2119,7 +2119,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", @@ -2399,7 +2399,7 @@ "ECP384", "PFS24", "PFS14", - "PFSMM" + "PFSMM" ], "x-ms-enum": { "name": "PfsGroup", @@ -2560,7 +2560,7 @@ "pfsGroup" ], "description": "An IPSec parameters for a virtual network gateway P2S connection." - }, + }, "LocalNetworkGatewayPropertiesFormat": { "properties": { "localNetworkAddressSpace": { @@ -2658,7 +2658,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualWan.json index e67f5886310d..3d95d5ea5450 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualWan.json @@ -342,7 +342,7 @@ "$ref": "./examples/VpnSiteGet.json" } }, - "description": "Retrieves the details of a VPNsite.", + "description": "Retrieves the details of a VPN site.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -2252,7 +2252,7 @@ }, "x-ms-long-running-operation": true } - } + } }, "definitions": { "VirtualWanProperties": { @@ -2298,7 +2298,7 @@ "items": { "$ref": "#/definitions/P2SVpnServerConfiguration" } - }, + }, "provisioningState": { "description": "The provisioning state of the resource.", "$ref": "#/definitions/ProvisioningState" @@ -2448,7 +2448,7 @@ "p2SVpnGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The P2SVpnGateway associated with this VirtualHub" - }, + }, "expressRouteGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The expressRouteGateway associated with this VirtualHub" @@ -2836,7 +2836,7 @@ "ProvisioningState": { "type": "string", "readOnly": true, - "description": "The current provisisoning state.", + "description": "The current provisioning state.", "enum": [ "Succeeded", "Updating", @@ -2996,8 +2996,8 @@ "publicCertData" ], "description": "Properties of Radius Server root certificate of P2SVpnServerConfiguration." - }, - "P2SVpnServerConfigRadiusServerRootCertificate": { + }, + "P2SVpnServerConfigRadiusServerRootCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, @@ -3096,13 +3096,13 @@ } ], "description": "Radius client root certificate of P2SVpnServerConfiguration." - }, - "P2SVpnServerConfigurationProperties": { + }, + "P2SVpnServerConfigurationProperties": { "properties": { "name": { "type": "string", - "description": "The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name." - }, + "description": "The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Parent VirtualWan resource name." + }, "vpnProtocols": { "type": "array", "items": { @@ -3160,7 +3160,7 @@ }, "radiusServerSecret": { "type": "string", - "description": "The radius secret property of the P2SVpnServerConfiguration resource for for point to site client connection." + "description": "The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection." }, "provisioningState": { "readOnly": true, @@ -3219,7 +3219,7 @@ "description": "URL to get the next set of operation list results if there are any." } } - }, + }, "VpnClientConnectionHealth": { "properties": { "totalIngressBytesTransferred": { @@ -3239,7 +3239,7 @@ "format": "int32", "description": "The total of p2s vpn clients connected at this time to this P2SVpnGateway." }, - "allocatedIpAddresses": { + "allocatedIpAddresses": { "type": "array", "items": { "type": "string" @@ -3248,8 +3248,8 @@ } }, "description": "VpnClientConnectionHealth properties" - }, - "P2SVpnGatewayProperties": { + }, + "P2SVpnGatewayProperties": { "properties": { "virtualHub": { "$ref": "./network.json#/definitions/SubResource", @@ -3274,8 +3274,8 @@ }, "vpnClientConnectionHealth": { "readOnly": true, - "$ref": "#/definitions/VpnClientConnectionHealth", - "description": "All P2S vpnclients' connection health status." + "$ref": "#/definitions/VpnClientConnectionHealth", + "description": "All P2S VPN clients' connection health status." } }, "description": "Parameters for P2SVpnGateway" @@ -3301,7 +3301,7 @@ } ], "description": "P2SVpnGateway Resource." - }, + }, "ListP2SVpnGatewaysResult": { "description": "Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.", "properties": { @@ -3343,6 +3343,6 @@ } }, "description": "Vpn Profile Response for package generation" - } + } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json index 7dab7e5d9985..06ce3f26f65b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json @@ -1953,7 +1953,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size for WAF." + "description": "Maximum request body size for WAF." }, "maxRequestBodySizeInKb": { "type": "integer", @@ -1962,7 +1962,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size in Kb for WAF." + "description": "Maximum request body size in Kb for WAF." }, "fileUploadLimitInMb": { "type": "integer", @@ -1971,7 +1971,7 @@ "exclusiveMaximum": false, "minimum": 0, "exclusiveMinimum": false, - "description": "Maxium file upload size in Mb for WAF." + "description": "Maximum file upload size in Mb for WAF." }, "exclusions": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewall.json index bd022bf77421..aa7aa2af530c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewall.json @@ -1,264 +1,264 @@ -{ +{ "swagger":"2.0", - "info":{ + "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-10-01" }, "host":"management.azure.com", - "schemes":[ + "schemes":[ "https" ], - "consumes":[ + "consumes":[ "application/json" ], - "produces":[ + "produces":[ "application/json" ], - "security":[ - { - "azure_auth":[ + "security":[ + { + "azure_auth":[ "user_impersonation" ] } ], - "securityDefinitions":{ - "azure_auth":{ + "securityDefinitions":{ + "azure_auth":{ "type":"oauth2", "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", "flow":"implicit", "description":"Azure Active Directory OAuth2 Flow", - "scopes":{ + "scopes":{ "user_impersonation":"impersonate your user account" } } }, - "paths":{ - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ - "delete":{ - "tags":[ + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ + "delete":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Delete", "description":"Deletes the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "202":{ + "responses":{ + "202":{ "description":"Accepted and the operation will complete asynchronously." }, - "204":{ + "204":{ "description":"Request successful. Resource with the specified name does not exist" }, - "200":{ + "200":{ "description":"Delete successful." } }, - "x-ms-examples":{ - "Delete Azure Firewall":{ + "x-ms-examples":{ + "Delete Azure Firewall":{ "$ref":"./examples/AzureFirewallDelete.json" } }, "x-ms-long-running-operation":true }, - "get":{ - "tags":[ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Get", "description":"Gets the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Request successful. The operation returns an AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Get Azure Firewall":{ + "x-ms-examples":{ + "Get Azure Firewall":{ "$ref":"./examples/AzureFirewallGet.json" } } }, - "put":{ - "tags":[ + "put":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_CreateOrUpdate", "description":"Creates or updates the specified Azure Firewall.", - "parameters":[ - { + "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":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" }, "description":"Parameters supplied to the create or update Azure Firewall operation." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "201":{ + "responses":{ + "201":{ "description":"Create successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } }, - "200":{ + "200":{ "description":"Update successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Create Azure Firewall":{ + "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":[ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_List", "description":"Lists all Azure Firewalls in a resource group.", - "parameters":[ - { + "parameters":[ + { "name":"resourceGroupName", "in":"path", "required":true, "type":"string", "description":"The name of the resource group." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given resource group":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given resource group":{ "$ref":"./examples/AzureFirewallListByResourceGroup.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ - "get":{ - "tags":[ + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_ListAll", "description":"Gets all the Azure Firewalls in a subscription.", - "parameters":[ - { + "parameters":[ + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given subscription":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given subscription":{ "$ref":"./examples/AzureFirewallListBySubscription.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } } }, - "definitions":{ - "AzureFirewallIPConfigurationPropertiesFormat":{ - "properties":{ + "definitions":{ + "AzureFirewallIPConfigurationPropertiesFormat":{ + "properties":{ "privateIPAddress": { "type": "string", "readOnly": true, @@ -272,111 +272,111 @@ "$ref": "./network.json#/definitions/SubResource", "description": "Reference of the PublicIP resource. This field is a mandatory input if subnet is not null." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of IP configuration of an Azure Firewall." }, - "AzureFirewallIPConfiguration":{ - "properties":{ - "properties":{ + "AzureFirewallIPConfiguration":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly": true, "description":"A unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"IP configuration of an Azure Firewall." }, - "AzureFirewallPropertiesFormat":{ - "properties":{ - "applicationRuleCollections":{ + "AzureFirewallPropertiesFormat":{ + "properties":{ + "applicationRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleCollection" }, "description":"Collection of application rule collections used by Azure Firewall." }, - "natRuleCollections":{ + "natRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNatRuleCollection" }, "description":"Collection of NAT rule collections used by Azure Firewall." }, - "networkRuleCollections":{ + "networkRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleCollection" }, "description":"Collection of network rule collections used by Azure Firewall." }, - "ipConfigurations":{ + "ipConfigurations":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallIPConfiguration" }, "description":"IP configuration of the Azure Firewall resource." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the Azure Firewall." }, - "AzureFirewall":{ - "properties":{ - "properties":{ + "AzureFirewall":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallPropertiesFormat" }, - "etag":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/Resource" } ], "description":"Azure Firewall resource" }, - "AzureFirewallListResult":{ - "properties":{ - "value":{ + "AzureFirewallListResult":{ + "properties":{ + "value":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewall" }, "description":"List of Azure Firewalls in a resource group." }, - "nextLink":{ + "nextLink":{ "type":"string", "description":"URL to get the next set of results." } }, "description":"Response for ListAzureFirewalls API service call." }, - "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -385,54 +385,54 @@ "exclusiveMinimum":false, "description":"Priority of the application rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRule" }, "description":"Collection of rules used by a application rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the application rule collection." }, - "AzureFirewallApplicationRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallApplicationRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Application rule collection resource" }, - "AzureFirewallApplicationRuleProtocol":{ - "properties":{ - "protocolType":{ + "AzureFirewallApplicationRuleProtocol":{ + "properties":{ + "protocolType":{ "description":"Protocol type", "$ref":"#/definitions/AzureFirewallApplicationRuleProtocolType" }, - "port":{ + "port":{ "type":"integer", "format":"int32", "maximum":64000, @@ -444,41 +444,41 @@ }, "description":"Properties of the application rule protocol." }, - "AzureFirewallApplicationRule":{ - "properties":{ - "name":{ + "AzureFirewallApplicationRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the application rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleProtocol" }, "description":"Array of ApplicationRuleProtocols." }, - "targetFqdns":{ + "targetFqdns":{ "type":"array", "description":"List of FQDNs for this rule.", - "items":{ + "items":{ "type":"string" } }, "fqdnTags":{ "type":"array", "description":"List of FQDN Tags for this rule.", - "items":{ + "items":{ "type":"string" } } @@ -486,8 +486,8 @@ "description":"Properties of an application rule." }, "AzureFirewallNatRuleCollectionProperties": { - "properties":{ - "priority":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -496,120 +496,120 @@ "exclusiveMinimum":false, "description":"Priority of the NAT rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallNatRCAction", "description":"The action type of a NAT rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNatRule" }, "description":"Collection of rules used by a NAT rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the NAT rule collection." }, - "AzureFirewallNatRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNatRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNatRuleCollectionProperties" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"NAT rule collection resource" }, - "AzureFirewallNatRule":{ - "properties":{ - "name":{ + "AzureFirewallNatRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the NAT rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule." }, - "translatedAddress":{ + "translatedAddress":{ "type":"string", "description":"The translated address for this NAT rule." }, - "translatedPort":{ + "translatedPort":{ "type":"string", "description":"The translated port for this NAT rule." } }, "description":"Properties of a NAT rule." }, - "AzureFirewallNatRCAction":{ - "properties":{ - "type":{ + "AzureFirewallNatRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallNatRCActionType" } }, "description":"AzureFirewall NAT Rule Collection Action." }, - "AzureFirewallNatRCActionType":{ + "AzureFirewallNatRCActionType":{ "type":"string", "description":"The action type of a NAT rule collection", - "enum":[ + "enum":[ "Snat", "Dnat" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNatRCActionType", "modelAsString":true } }, - "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -618,146 +618,146 @@ "exclusiveMinimum":false, "description":"Priority of the network rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRule" }, "description":"Collection of rules used by a network rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the network rule collection." }, - "AzureFirewallNetworkRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNetworkRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Network rule collection resource" }, - "AzureFirewallNetworkRule":{ - "properties":{ - "name":{ + "AzureFirewallNetworkRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the network rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of the network rule." }, - "AzureFirewallRCAction":{ - "properties":{ - "type":{ + "AzureFirewallRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallRCActionType" } }, "description":"Properties of the AzureFirewallRCAction." }, - "AzureFirewallRCActionType":{ + "AzureFirewallRCActionType":{ "type":"string", "description":"The action type of a rule collection", - "enum":[ + "enum":[ "Allow", "Deny" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallRCActionType", "modelAsString":true } }, - "ProvisioningState":{ + "ProvisioningState":{ "type":"string", "readOnly":true, - "description":"The current provisisoning state.", - "enum":[ + "description":"The current provisioning state.", + "enum":[ "Succeeded", "Updating", "Deleting", "Failed" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"ProvisioningState", "modelAsString":true } }, - "AzureFirewallNetworkRuleProtocol":{ + "AzureFirewallNetworkRuleProtocol":{ "type":"string", "description":"The protocol of a Network Rule resource", - "enum":[ + "enum":[ "TCP", "UDP", "Any", "ICMP" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNetworkRuleProtocol", "modelAsString":true } }, - "AzureFirewallApplicationRuleProtocolType":{ + "AzureFirewallApplicationRuleProtocolType":{ "type":"string", "description":"The protocol type of a Application Rule resource", - "enum":[ + "enum":[ "Http", "Https" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallApplicationRuleProtocolType", "modelAsString":true } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointCreate.json index a95ab3fb56a8..36f688d418a6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointCreate.json @@ -24,7 +24,7 @@ "location" : "eastus", "properties" : { "fqdn": "uniqueIdentifier.fqdn.windows.net", - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "owner": "User", "endpointService": { "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationCreate.json index 80a4059ebd3e..3ba769651379 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationCreate.json @@ -24,7 +24,7 @@ "virtualNetworkTap": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, - "provisioningState": "Succeded" + "provisioningState": "Succeeded" } } }, @@ -38,7 +38,7 @@ "virtualNetworkTap": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, - "provisioningState": "Succeded" + "provisioningState": "Succeeded" } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationGet.json index 219eb0907821..6ec50de4c86a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationGet.json @@ -18,7 +18,7 @@ "virtualNetworkTap": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, - "provisioningState": "Succeded" + "provisioningState": "Succeeded" } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationList.json index a982d6013bba..b8d133397b5d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationList.json @@ -18,7 +18,7 @@ "virtualNetworkTap": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" }, - "provisioningState": "Succeded" + "provisioningState": "Succeeded" } } ] diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapCreate.json index 56d8e18ab711..d18282d548d2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapCreate.json @@ -26,7 +26,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { @@ -48,7 +48,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapGet.json index 7dbee26fdd46..07c945fde606 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapGet.json @@ -18,7 +18,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapList.json index 0215ca43f1a3..7cdb383ace3e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapList.json @@ -19,7 +19,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { @@ -39,7 +39,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapListAll.json index 9cb69a1de457..bf9839592606 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapListAll.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapListAll.json @@ -18,7 +18,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { @@ -38,7 +38,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", "networkInterfaceTapConfigurations": [ { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapUpdateTags.json index cee390b2ec00..d67b6180bec1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapUpdateTags.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapUpdateTags.json @@ -26,7 +26,7 @@ "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" }, "destinationPort": 4789, - "provisioningState": "Succeded", + "provisioningState": "Succeeded", "networkInterfaceTapConfigurations": [ { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json index c45272011765..dcb2522f2db0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json @@ -83,7 +83,7 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Delete ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" } + "Delete ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" } } }, "get": { @@ -130,7 +130,7 @@ } }, "x-ms-examples": { - "Get ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" } + "Get ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" } } }, "put": { @@ -192,8 +192,8 @@ } }, "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" } + "x-ms-examples": { + "Create ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" } } } }, @@ -237,8 +237,8 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-examples": { - "List ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" } + "x-ms-examples": { + "List ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" } } } }, @@ -505,7 +505,7 @@ } }, "x-ms-examples": { - "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" } + "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" } }, "x-ms-long-running-operation": true }, @@ -607,7 +607,7 @@ "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" }, - "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + "description": "Parameters supplied to the create or update express route circuit connection operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -685,8 +685,8 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-examples": { - "List ExpressRouteCircuit Connection": { "$ref": "./examples/ExpressRouteCircuitConnectionList.json" } + "x-ms-examples": { + "List ExpressRouteCircuit Connection": { "$ref": "./examples/ExpressRouteCircuitConnectionList.json" } } } }, @@ -1220,7 +1220,7 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "List ExpressRouteCircuits in a subscription": { "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" } + "List ExpressRouteCircuits in a subscription": { "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" } } } }, @@ -1241,7 +1241,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1334,7 +1334,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", @@ -1612,7 +1612,7 @@ "provisioningState": { "type": "string", "readOnly": true, - "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } } }, @@ -1782,7 +1782,7 @@ "allowGlobalReach": { "type": "boolean", "description": "Flag to enable Global Reach on the circuit." - } + } }, "description": "Properties of ExpressRouteCircuit." }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json index 4baf23a87757..6dffd639bc54 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } @@ -91,7 +91,7 @@ ], "responses": { "200": { - "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRoutePort.json index ff96bc44fa0b..49919ac2b350 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRoutePort.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRoutePort.json @@ -40,7 +40,7 @@ "ExpressRoutePortsLocations" ], "operationId": "ExpressRoutePortsLocations_List", - "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retriving a specific peering location.", + "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -516,7 +516,7 @@ { "$ref": "./network.json#/definitions/Resource" } - ] + ] }, "ExpressRoutePortsLocationListResult": { "title": "ExpressRoutePorts Location List Result", @@ -670,7 +670,7 @@ "etherType": { "readOnly": true, "type": "string", - "description": "Ethertype of the physical port." + "description": "Ether type of the physical port." }, "allocationDate": { "readOnly": true, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkInterface.json index 9cd88aca4b68..ec2343c041a9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkInterface.json @@ -580,7 +580,7 @@ "description": "Delete successful." } }, - "x-ms-examples": + "x-ms-examples": { "Delete tap configuration": { "$ref": "./examples/NetworkInterfaceTapConfigurationDelete.json" } }, @@ -629,7 +629,7 @@ } } }, - "x-ms-examples": + "x-ms-examples": { "Get Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationGet.json" } } @@ -692,7 +692,7 @@ } } }, - "x-ms-examples": + "x-ms-examples": { "Create Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationCreate.json" } }, @@ -776,7 +776,7 @@ }, "NetworkInterfaceTapConfigurationPropertiesFormat": { "properties": { - "virtualNetworkTap": { + "virtualNetworkTap": { "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap", "description": "The reference of the Virtual Network Tap resource." }, @@ -1158,14 +1158,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -1180,14 +1180,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkProfile.json index a544279ff225..fb8c6063c39e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkProfile.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkProfile.json @@ -100,7 +100,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the PublicIPPrefx." + "description": "The name of the Public IP Prefix." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -268,7 +268,7 @@ } }, "x-ms-examples": { - "List all network profilees": { + "List all network profiles": { "$ref": "./examples/NetworkProfileListAll.json" } }, @@ -308,7 +308,7 @@ } }, "x-ms-examples": { - "List resource group network profilees": { + "List resource group network profiles": { "$ref": "./examples/NetworkProfileList.json" } }, @@ -391,7 +391,7 @@ }, "container": { "$ref": "#/definitions/Container", - "description": "Reference to the conatinaer to which this container network interface is attached." + "description": "Reference to the container to which this container network interface is attached." }, "ipConfigurations": { "type": "array", @@ -485,13 +485,13 @@ "$ref": "./network.json#/definitions/SubResource" } ], - "description": "Container network interface configruation child resource." + "description": "Container network interface configuration child resource." }, "IPConfigurationProfilePropertiesFormat": { "properties": { "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", - "description": "The reference of the subnet resource to create a contatainer network interface ip configruation." + "description": "The reference of the subnet resource to create a container network interface ip configuration." }, "provisioningState": { "readOnly": true, @@ -499,7 +499,7 @@ "description": "The provisioning state of the resource." } }, - "description": "IP configruation profile properties." + "description": "IP configuration profile properties." }, "IPConfigurationProfile": { "properties": { @@ -555,7 +555,7 @@ "$ref": "#/definitions/ContainerNetworkInterfaceIpConfigurationPropertiesFormat", "description": "Properties of the container network interface IP configuration." }, - "name": { + "name": { "type": "string", "description": "The name of the resource. This name can be used to access the resource." }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json index 40f9da06d593..9d1ec01bdcb9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json @@ -628,15 +628,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' 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. " + "description": "The CIDR or source IP range. Asterisk '*' 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", @@ -654,7 +654,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -705,7 +705,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json index 8d4190a3b8d7..a18d8e928dc0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json @@ -1785,8 +1785,8 @@ ], "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, "description": "Get network configuration diagnostic.", "parameters": [ @@ -1822,7 +1822,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns the result of network condifuration diagnostic.", + "description": "Request successful. The operation returns the result of network configuration diagnostic.", "schema": { "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" } @@ -3200,7 +3200,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -3385,7 +3385,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { @@ -3468,7 +3468,7 @@ "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." }, "verbosityLevel": { - "type": "string", + "type": "string", "enum": [ "Normal", "Minimum", @@ -3525,7 +3525,7 @@ }, "destinationPort": { "type": "string", - "description": "Traffice destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." + "description": "Traffic destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json index 89700bd2fc1c..00f4202ccf89 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json @@ -98,7 +98,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the PublicIPPrefx." + "description": "The name of the Public IP Prefix." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json index 6a49211e0458..601a4c3b4b96 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json @@ -75,7 +75,7 @@ } }, "x-ms-examples": { - "Delete service endpoint Policys": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } + "Delete service endpoint Policy": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } }, "x-ms-long-running-operation": true }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json index 924e019d8969..e28432eab3c9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json @@ -795,7 +795,7 @@ "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.", + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", "schema": { "$ref": "#/definitions/VpnClientIPsecParameters" } @@ -846,8 +846,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } - } + "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } + } } }, @@ -1766,7 +1766,7 @@ "$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." @@ -2399,7 +2399,7 @@ "ECP384", "PFS24", "PFS14", - "PFSMM" + "PFSMM" ], "x-ms-enum": { "name": "PfsGroup", @@ -2560,7 +2560,7 @@ "pfsGroup" ], "description": "An IPSec parameters for a virtual network gateway P2S connection." - }, + }, "LocalNetworkGatewayPropertiesFormat": { "properties": { "localNetworkAddressSpace": { @@ -2658,7 +2658,7 @@ }, "connectionType": { "type": "string", - "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualWan.json index 0c4ec22bea82..95211429158a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualWan.json @@ -342,7 +342,7 @@ "$ref": "./examples/VpnSiteGet.json" } }, - "description": "Retrieves the details of a VPNsite.", + "description": "Retrieves the details of a VPN site.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -2252,7 +2252,7 @@ }, "x-ms-long-running-operation": true } - } + } }, "definitions": { "VirtualWanProperties": { @@ -2298,7 +2298,7 @@ "items": { "$ref": "#/definitions/P2SVpnServerConfiguration" } - }, + }, "provisioningState": { "description": "The provisioning state of the resource.", "$ref": "#/definitions/ProvisioningState" @@ -2448,7 +2448,7 @@ "p2SVpnGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The P2SVpnGateway associated with this VirtualHub" - }, + }, "expressRouteGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The expressRouteGateway associated with this VirtualHub" @@ -2836,7 +2836,7 @@ "ProvisioningState": { "type": "string", "readOnly": true, - "description": "The current provisisoning state.", + "description": "The current provisioning state.", "enum": [ "Succeeded", "Updating", @@ -2996,7 +2996,7 @@ "publicCertData" ], "description": "Properties of Radius Server root certificate of P2SVpnServerConfiguration." - }, + }, "P2SVpnServerConfigRadiusServerRootCertificate": { "properties": { "properties": { @@ -3096,13 +3096,13 @@ } ], "description": "Radius client root certificate of P2SVpnServerConfiguration." - }, + }, "P2SVpnServerConfigurationProperties": { "properties": { "name": { "type": "string", - "description": "The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name." - }, + "description": "The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Parent VirtualWan resource name." + }, "vpnProtocols": { "type": "array", "items": { @@ -3160,7 +3160,7 @@ }, "radiusServerSecret": { "type": "string", - "description": "The radius secret property of the P2SVpnServerConfiguration resource for for point to site client connection." + "description": "The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection." }, "provisioningState": { "readOnly": true, @@ -3219,7 +3219,7 @@ "description": "URL to get the next set of operation list results if there are any." } } - }, + }, "VpnClientConnectionHealth": { "properties": { "totalIngressBytesTransferred": { @@ -3248,7 +3248,7 @@ } }, "description": "VpnClientConnectionHealth properties" - }, + }, "P2SVpnGatewayProperties": { "properties": { "virtualHub": { @@ -3275,7 +3275,7 @@ "vpnClientConnectionHealth": { "readOnly": true, "$ref": "#/definitions/VpnClientConnectionHealth", - "description": "All P2S vpnclients' connection health status." + "description": "All P2S VPN clients' connection health status." } }, "description": "Parameters for P2SVpnGateway" @@ -3301,7 +3301,7 @@ } ], "description": "P2SVpnGateway Resource." - }, + }, "ListP2SVpnGatewaysResult": { "description": "Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.", "properties": { @@ -3343,6 +3343,6 @@ } }, "description": "Vpn Profile Response for package generation" - } + } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/applicationGateway.json index 083f728fd73d..fc7f54fa90ad 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/applicationGateway.json @@ -2061,7 +2061,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size for WAF." + "description": "Maximum request body size for WAF." }, "maxRequestBodySizeInKb": { "type": "integer", @@ -2070,7 +2070,7 @@ "exclusiveMaximum": false, "minimum": 8, "exclusiveMinimum": false, - "description": "Maxium request body size in Kb for WAF." + "description": "Maximum request body size in Kb for WAF." }, "fileUploadLimitInMb": { "type": "integer", @@ -2079,7 +2079,7 @@ "exclusiveMaximum": false, "minimum": 0, "exclusiveMinimum": false, - "description": "Maxium file upload size in Mb for WAF." + "description": "Maximum file upload size in Mb for WAF." }, "exclusions": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/azureFirewall.json index 9c1524d65f19..189a5f664b37 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/azureFirewall.json @@ -1,264 +1,264 @@ -{ +{ "swagger":"2.0", - "info":{ + "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-11-01" }, "host":"management.azure.com", - "schemes":[ + "schemes":[ "https" ], - "consumes":[ + "consumes":[ "application/json" ], - "produces":[ + "produces":[ "application/json" ], - "security":[ - { - "azure_auth":[ + "security":[ + { + "azure_auth":[ "user_impersonation" ] } ], - "securityDefinitions":{ - "azure_auth":{ + "securityDefinitions":{ + "azure_auth":{ "type":"oauth2", "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", "flow":"implicit", "description":"Azure Active Directory OAuth2 Flow", - "scopes":{ + "scopes":{ "user_impersonation":"impersonate your user account" } } }, - "paths":{ - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ - "delete":{ - "tags":[ + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ + "delete":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Delete", "description":"Deletes the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "202":{ + "responses":{ + "202":{ "description":"Accepted and the operation will complete asynchronously." }, - "204":{ + "204":{ "description":"Request successful. Resource with the specified name does not exist" }, - "200":{ + "200":{ "description":"Delete successful." } }, - "x-ms-examples":{ - "Delete Azure Firewall":{ + "x-ms-examples":{ + "Delete Azure Firewall":{ "$ref":"./examples/AzureFirewallDelete.json" } }, "x-ms-long-running-operation":true }, - "get":{ - "tags":[ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_Get", "description":"Gets the specified Azure Firewall.", - "parameters":[ - { + "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":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Request successful. The operation returns an AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Get Azure Firewall":{ + "x-ms-examples":{ + "Get Azure Firewall":{ "$ref":"./examples/AzureFirewallGet.json" } } }, - "put":{ - "tags":[ + "put":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_CreateOrUpdate", "description":"Creates or updates the specified Azure Firewall.", - "parameters":[ - { + "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":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" }, "description":"Parameters supplied to the create or update Azure Firewall operation." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "201":{ + "responses":{ + "201":{ "description":"Create successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } }, - "200":{ + "200":{ "description":"Update successful. The operation returns the resulting AzureFirewall resource.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewall" } } }, - "x-ms-examples":{ - "Create Azure Firewall":{ + "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":[ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_List", "description":"Lists all Azure Firewalls in a resource group.", - "parameters":[ - { + "parameters":[ + { "name":"resourceGroupName", "in":"path", "required":true, "type":"string", "description":"The name of the resource group." }, - { + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given resource group":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given resource group":{ "$ref":"./examples/AzureFirewallListByResourceGroup.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ - "get":{ - "tags":[ + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ "AzureFirewalls" ], "operationId":"AzureFirewalls_ListAll", "description":"Gets all the Azure Firewalls in a subscription.", - "parameters":[ - { + "parameters":[ + { "$ref":"./network.json#/parameters/ApiVersionParameter" }, - { + { "$ref":"./network.json#/parameters/SubscriptionIdParameter" } ], - "responses":{ - "200":{ + "responses":{ + "200":{ "description":"Success. The operation returns a list of AzureFirewall resources.", - "schema":{ + "schema":{ "$ref":"#/definitions/AzureFirewallListResult" } } }, - "x-ms-examples":{ - "List all Azure Firewalls for a given subscription":{ + "x-ms-examples":{ + "List all Azure Firewalls for a given subscription":{ "$ref":"./examples/AzureFirewallListBySubscription.json" } }, - "x-ms-pageable":{ + "x-ms-pageable":{ "nextLinkName":"nextLink" } } } }, - "definitions":{ - "AzureFirewallIPConfigurationPropertiesFormat":{ - "properties":{ + "definitions":{ + "AzureFirewallIPConfigurationPropertiesFormat":{ + "properties":{ "privateIPAddress": { "type": "string", "readOnly": true, @@ -272,111 +272,111 @@ "$ref": "./network.json#/definitions/SubResource", "description": "Reference of the PublicIP resource. This field is a mandatory input if subnet is not null." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of IP configuration of an Azure Firewall." }, - "AzureFirewallIPConfiguration":{ - "properties":{ - "properties":{ + "AzureFirewallIPConfiguration":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly": true, "description":"A unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"IP configuration of an Azure Firewall." }, - "AzureFirewallPropertiesFormat":{ - "properties":{ - "applicationRuleCollections":{ + "AzureFirewallPropertiesFormat":{ + "properties":{ + "applicationRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleCollection" }, "description":"Collection of application rule collections used by Azure Firewall." }, - "natRuleCollections":{ + "natRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNatRuleCollection" }, "description":"Collection of NAT rule collections used by Azure Firewall." }, - "networkRuleCollections":{ + "networkRuleCollections":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleCollection" }, "description":"Collection of network rule collections used by Azure Firewall." }, - "ipConfigurations":{ + "ipConfigurations":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallIPConfiguration" }, "description":"IP configuration of the Azure Firewall resource." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the Azure Firewall." }, - "AzureFirewall":{ - "properties":{ - "properties":{ + "AzureFirewall":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallPropertiesFormat" }, - "etag":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/Resource" } ], "description":"Azure Firewall resource" }, - "AzureFirewallListResult":{ - "properties":{ - "value":{ + "AzureFirewallListResult":{ + "properties":{ + "value":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewall" }, "description":"List of Azure Firewalls in a resource group." }, - "nextLink":{ + "nextLink":{ "type":"string", "description":"URL to get the next set of results." } }, "description":"Response for ListAzureFirewalls API service call." }, - "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -385,54 +385,54 @@ "exclusiveMinimum":false, "description":"Priority of the application rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRule" }, "description":"Collection of rules used by a application rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the application rule collection." }, - "AzureFirewallApplicationRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallApplicationRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Application rule collection resource" }, - "AzureFirewallApplicationRuleProtocol":{ - "properties":{ - "protocolType":{ + "AzureFirewallApplicationRuleProtocol":{ + "properties":{ + "protocolType":{ "description":"Protocol type", "$ref":"#/definitions/AzureFirewallApplicationRuleProtocolType" }, - "port":{ + "port":{ "type":"integer", "format":"int32", "maximum":64000, @@ -444,41 +444,41 @@ }, "description":"Properties of the application rule protocol." }, - "AzureFirewallApplicationRule":{ - "properties":{ - "name":{ + "AzureFirewallApplicationRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the application rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallApplicationRuleProtocol" }, "description":"Array of ApplicationRuleProtocols." }, - "targetFqdns":{ + "targetFqdns":{ "type":"array", "description":"List of FQDNs for this rule.", - "items":{ + "items":{ "type":"string" } }, "fqdnTags":{ "type":"array", "description":"List of FQDN Tags for this rule.", - "items":{ + "items":{ "type":"string" } } @@ -486,8 +486,8 @@ "description":"Properties of an application rule." }, "AzureFirewallNatRuleCollectionProperties": { - "properties":{ - "priority":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -496,120 +496,120 @@ "exclusiveMinimum":false, "description":"Priority of the NAT rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallNatRCAction", "description":"The action type of a NAT rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNatRule" }, "description":"Collection of rules used by a NAT rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the NAT rule collection." }, - "AzureFirewallNatRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNatRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNatRuleCollectionProperties" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"NAT rule collection resource" }, - "AzureFirewallNatRule":{ - "properties":{ - "name":{ + "AzureFirewallNatRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the NAT rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule." }, - "translatedAddress":{ + "translatedAddress":{ "type":"string", "description":"The translated address for this NAT rule." }, - "translatedPort":{ + "translatedPort":{ "type":"string", "description":"The translated port for this NAT rule." } }, "description":"Properties of a NAT rule." }, - "AzureFirewallNatRCAction":{ - "properties":{ - "type":{ + "AzureFirewallNatRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallNatRCActionType" } }, "description":"AzureFirewall NAT Rule Collection Action." }, - "AzureFirewallNatRCActionType":{ + "AzureFirewallNatRCActionType":{ "type":"string", "description":"The action type of a NAT rule collection", - "enum":[ + "enum":[ "Snat", "Dnat" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNatRCActionType", "modelAsString":true } }, - "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ - "properties":{ - "priority":{ + "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ "type":"integer", "format":"int32", "maximum":65000, @@ -618,146 +618,146 @@ "exclusiveMinimum":false, "description":"Priority of the network rule collection resource." }, - "action":{ + "action":{ "$ref":"#/definitions/AzureFirewallRCAction", "description":"The action type of a rule collection" }, - "rules":{ + "rules":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRule" }, "description":"Collection of rules used by a network rule collection." }, - "provisioningState":{ + "provisioningState":{ "description":"The provisioning state of the resource.", "$ref":"#/definitions/ProvisioningState" } }, "description":"Properties of the network rule collection." }, - "AzureFirewallNetworkRuleCollection":{ - "properties":{ - "properties":{ + "AzureFirewallNetworkRuleCollection":{ + "properties":{ + "properties":{ "x-ms-client-flatten":true, "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" }, - "name":{ + "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":{ + "etag":{ "type":"string", "readOnly":true, "description":"Gets a unique read-only string that changes whenever the resource is updated." } }, - "allOf":[ - { + "allOf":[ + { "$ref":"./network.json#/definitions/SubResource" } ], "description":"Network rule collection resource" }, - "AzureFirewallNetworkRule":{ - "properties":{ - "name":{ + "AzureFirewallNetworkRule":{ + "properties":{ + "name":{ "type":"string", "description":"Name of the network rule." }, - "description":{ + "description":{ "type":"string", "description":"Description of the rule." }, - "protocols":{ + "protocols":{ "type":"array", - "items":{ + "items":{ "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" }, "description":"Array of AzureFirewallNetworkRuleProtocols." }, - "sourceAddresses":{ + "sourceAddresses":{ "type":"array", "description":"List of source IP addresses for this rule.", - "items":{ + "items":{ "type":"string" } }, - "destinationAddresses":{ + "destinationAddresses":{ "type":"array", "description":"List of destination IP addresses.", - "items":{ + "items":{ "type":"string" } }, - "destinationPorts":{ + "destinationPorts":{ "type":"array", "description":"List of destination ports.", - "items":{ + "items":{ "type":"string" } } }, "description":"Properties of the network rule." }, - "AzureFirewallRCAction":{ - "properties":{ - "type":{ + "AzureFirewallRCAction":{ + "properties":{ + "type":{ "description":"The type of action.", "$ref":"#/definitions/AzureFirewallRCActionType" } }, "description":"Properties of the AzureFirewallRCAction." }, - "AzureFirewallRCActionType":{ + "AzureFirewallRCActionType":{ "type":"string", "description":"The action type of a rule collection", - "enum":[ + "enum":[ "Allow", "Deny" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallRCActionType", "modelAsString":true } }, - "ProvisioningState":{ + "ProvisioningState":{ "type":"string", "readOnly":true, - "description":"The current provisisoning state.", - "enum":[ + "description":"The current provisioning state.", + "enum":[ "Succeeded", "Updating", "Deleting", "Failed" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"ProvisioningState", "modelAsString":true } }, - "AzureFirewallNetworkRuleProtocol":{ + "AzureFirewallNetworkRuleProtocol":{ "type":"string", "description":"The protocol of a Network Rule resource", - "enum":[ + "enum":[ "TCP", "UDP", "Any", "ICMP" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallNetworkRuleProtocol", "modelAsString":true } }, - "AzureFirewallApplicationRuleProtocolType":{ + "AzureFirewallApplicationRuleProtocolType":{ "type":"string", "description":"The protocol type of a Application Rule resource", - "enum":[ + "enum":[ "Http", "Https" ], - "x-ms-enum":{ + "x-ms-enum":{ "name":"AzureFirewallApplicationRuleProtocolType", "modelAsString":true } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/examples/ExpressRouteGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/examples/ExpressRouteGatewayGet.json index 6bd7e370d2d6..db834cda9499 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/examples/ExpressRouteGatewayGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/examples/ExpressRouteGatewayGet.json @@ -20,7 +20,6 @@ } } } - }, - "404": {} + } } } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRouteCircuit.json index 2bd8f635af9b..88da92494c44 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRouteCircuit.json @@ -83,7 +83,7 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Delete ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" } + "Delete ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" } } }, "get": { @@ -130,7 +130,7 @@ } }, "x-ms-examples": { - "Get ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" } + "Get ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" } } }, "put": { @@ -192,8 +192,8 @@ } }, "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" } + "x-ms-examples": { + "Create ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" } } } }, @@ -237,8 +237,8 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-examples": { - "List ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" } + "x-ms-examples": { + "List ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" } } } }, @@ -505,7 +505,7 @@ } }, "x-ms-examples": { - "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" } + "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" } }, "x-ms-long-running-operation": true }, @@ -607,7 +607,7 @@ "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" }, - "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + "description": "Parameters supplied to the create or update express route circuit connection operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -685,8 +685,8 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-examples": { - "List ExpressRouteCircuit Connection": { "$ref": "./examples/ExpressRouteCircuitConnectionList.json" } + "x-ms-examples": { + "List ExpressRouteCircuit Connection": { "$ref": "./examples/ExpressRouteCircuitConnectionList.json" } } } }, @@ -1220,7 +1220,7 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "List ExpressRouteCircuits in a subscription": { "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" } + "List ExpressRouteCircuits in a subscription": { "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" } } } }, @@ -1241,7 +1241,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1334,7 +1334,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", @@ -1612,7 +1612,7 @@ "provisioningState": { "type": "string", "readOnly": true, - "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } } }, @@ -1782,7 +1782,7 @@ "allowGlobalReach": { "type": "boolean", "description": "Flag to enable Global Reach on the circuit." - } + } }, "description": "Properties of ExpressRouteCircuit." }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRouteCrossConnection.json index 8fd938ef52dd..cefae4f99271 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRouteCrossConnection.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRouteCrossConnection.json @@ -51,7 +51,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } @@ -91,7 +91,7 @@ ], "responses": { "200": { - "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", "schema": { "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRoutePort.json index b2f94691b752..6e11cd73ecb6 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRoutePort.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/expressRoutePort.json @@ -40,7 +40,7 @@ "ExpressRoutePortsLocations" ], "operationId": "ExpressRoutePortsLocations_List", - "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retriving a specific peering location.", + "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -516,7 +516,7 @@ { "$ref": "./network.json#/definitions/Resource" } - ] + ] }, "ExpressRoutePortsLocationListResult": { "title": "ExpressRoutePorts Location List Result", @@ -670,7 +670,7 @@ "etherType": { "readOnly": true, "type": "string", - "description": "Ethertype of the physical port." + "description": "Ether type of the physical port." }, "allocationDate": { "readOnly": true, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkInterface.json index 2f293bf4b8bb..0b0ebb6805ac 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkInterface.json @@ -580,7 +580,7 @@ "description": "Delete successful." } }, - "x-ms-examples": + "x-ms-examples": { "Delete tap configuration": { "$ref": "./examples/NetworkInterfaceTapConfigurationDelete.json" } }, @@ -629,7 +629,7 @@ } } }, - "x-ms-examples": + "x-ms-examples": { "Get Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationGet.json" } } @@ -692,7 +692,7 @@ } } }, - "x-ms-examples": + "x-ms-examples": { "Create Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationCreate.json" } }, @@ -776,7 +776,7 @@ }, "NetworkInterfaceTapConfigurationPropertiesFormat": { "properties": { - "virtualNetworkTap": { + "virtualNetworkTap": { "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap", "description": "The reference of the Virtual Network Tap resource." }, @@ -1158,14 +1158,14 @@ "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 (*)" + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "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 (*)" + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)" }, "sourceAddressPrefix": { "type": "string", @@ -1180,14 +1180,14 @@ "items": { "type": "string" }, - "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "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 (*)." + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." }, "expandedSourceAddressPrefix": { "type": "array", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkProfile.json index b7704e7398e5..4790e2c7e5ba 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkProfile.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkProfile.json @@ -100,7 +100,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the PublicIPPrefx." + "description": "The name of the PublicIPPrefix." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -268,7 +268,7 @@ } }, "x-ms-examples": { - "List all network profilees": { + "List all network profiles": { "$ref": "./examples/NetworkProfileListAll.json" } }, @@ -308,7 +308,7 @@ } }, "x-ms-examples": { - "List resource group network profilees": { + "List resource group network profiles": { "$ref": "./examples/NetworkProfileList.json" } }, @@ -391,7 +391,7 @@ }, "container": { "$ref": "#/definitions/Container", - "description": "Reference to the conatinaer to which this container network interface is attached." + "description": "Reference to the container to which this container network interface is attached." }, "ipConfigurations": { "type": "array", @@ -485,13 +485,13 @@ "$ref": "./network.json#/definitions/SubResource" } ], - "description": "Container network interface configruation child resource." + "description": "Container network interface configuration child resource." }, "IPConfigurationProfilePropertiesFormat": { "properties": { "subnet": { "$ref": "./virtualNetwork.json#/definitions/Subnet", - "description": "The reference of the subnet resource to create a contatainer network interface ip configruation." + "description": "The reference of the subnet resource to create a container network interface ip configuration." }, "provisioningState": { "readOnly": true, @@ -499,7 +499,7 @@ "description": "The provisioning state of the resource." } }, - "description": "IP configruation profile properties." + "description": "IP configuration profile properties." }, "IPConfigurationProfile": { "properties": { @@ -555,7 +555,7 @@ "$ref": "#/definitions/ContainerNetworkInterfaceIpConfigurationPropertiesFormat", "description": "Properties of the container network interface IP configuration." }, - "name": { + "name": { "type": "string", "description": "The name of the resource. This name can be used to access the resource." }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkSecurityGroup.json index d74196744274..703911a144d1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkSecurityGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkSecurityGroup.json @@ -628,15 +628,15 @@ }, "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." + "description": "The source port or range. Integer or range between 0 and 65535. Asterisks '*' 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." + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisks '*' 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. " + "description": "The CIDR or source IP range. Asterisks '*' 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", @@ -654,7 +654,7 @@ }, "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." + "description": "The destination address prefix. CIDR or destination IP range. Asterisks '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." }, "destinationAddressPrefixes": { "type": "array", @@ -705,7 +705,7 @@ }, "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'.", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are: 'Inbound' and 'Outbound'.", "enum": [ "Inbound", "Outbound" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkWatcher.json index f2935f40515d..b22bc15365ff 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/networkWatcher.json @@ -1785,8 +1785,8 @@ ], "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" + "x-ms-long-running-operation-options": { + "final-state-via": "location" }, "description": "Get network configuration diagnostic.", "parameters": [ @@ -1822,7 +1822,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns the result of network condifuration diagnostic.", + "description": "Request successful. The operation returns the result of network configuration diagnostic.", "schema": { "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" } @@ -3200,7 +3200,7 @@ "properties": { "location": { "type": "string", - "description": "Connection monitor location." + "description": "Connection monitor location." }, "tags": { "type": "object", @@ -3385,7 +3385,7 @@ "description": "Information about connection states." } }, - "description": "List of connection states snaphots." + "description": "List of connection states snapshots." }, "ConnectionStateSnapshot": { "properties": { @@ -3468,7 +3468,7 @@ "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." }, "verbosityLevel": { - "type": "string", + "type": "string", "enum": [ "Normal", "Minimum", @@ -3525,7 +3525,7 @@ }, "destinationPort": { "type": "string", - "description": "Traffice destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." + "description": "Traffic destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/publicIpPrefix.json index 1bfa476d00c0..9e152d04866d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/publicIpPrefix.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/publicIpPrefix.json @@ -98,7 +98,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the PublicIPPrefx." + "description": "The name of the PublicIPPrefix." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/serviceEndpointPolicy.json index 91797c8fd711..93d2b601396d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/serviceEndpointPolicy.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/serviceEndpointPolicy.json @@ -75,7 +75,7 @@ } }, "x-ms-examples": { - "Delete service endpoint Policys": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } + "Delete service endpoint Policies": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } }, "x-ms-long-running-operation": true }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualNetworkGateway.json index 7f00852047d3..465257f50b1b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualNetworkGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualNetworkGateway.json @@ -795,7 +795,7 @@ "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.", + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", "schema": { "$ref": "#/definitions/VpnClientIPsecParameters" } @@ -846,8 +846,8 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } - } + "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } + } } }, @@ -1766,7 +1766,7 @@ "$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." @@ -2399,7 +2399,7 @@ "ECP384", "PFS24", "PFS14", - "PFSMM" + "PFSMM" ], "x-ms-enum": { "name": "PfsGroup", @@ -2560,7 +2560,7 @@ "pfsGroup" ], "description": "An IPSec parameters for a virtual network gateway P2S connection." - }, + }, "LocalNetworkGatewayPropertiesFormat": { "properties": { "localNetworkAddressSpace": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualWan.json index 0e2e83447073..75b2c73c45be 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-11-01/virtualWan.json @@ -342,7 +342,7 @@ "$ref": "./examples/VpnSiteGet.json" } }, - "description": "Retrieves the details of a VPNsite.", + "description": "Retrieves the details of a VPN site.", "parameters": [ { "$ref": "./network.json#/parameters/SubscriptionIdParameter" @@ -2252,7 +2252,7 @@ }, "x-ms-long-running-operation": true } - } + } }, "definitions": { "VirtualWanProperties": { @@ -2298,7 +2298,7 @@ "items": { "$ref": "#/definitions/P2SVpnServerConfiguration" } - }, + }, "provisioningState": { "description": "The provisioning state of the resource.", "$ref": "#/definitions/ProvisioningState" @@ -2448,7 +2448,7 @@ "p2SVpnGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The P2SVpnGateway associated with this VirtualHub" - }, + }, "expressRouteGateway": { "$ref": "./network.json#/definitions/SubResource", "description": "The expressRouteGateway associated with this VirtualHub" @@ -2836,7 +2836,7 @@ "ProvisioningState": { "type": "string", "readOnly": true, - "description": "The current provisisoning state.", + "description": "The current provisioning state.", "enum": [ "Succeeded", "Updating", @@ -2996,7 +2996,7 @@ "publicCertData" ], "description": "Properties of Radius Server root certificate of P2SVpnServerConfiguration." - }, + }, "P2SVpnServerConfigRadiusServerRootCertificate": { "properties": { "properties": { @@ -3096,13 +3096,13 @@ } ], "description": "Radius client root certificate of P2SVpnServerConfiguration." - }, + }, "P2SVpnServerConfigurationProperties": { "properties": { "name": { "type": "string", "description": "The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name." - }, + }, "vpnProtocols": { "type": "array", "items": { @@ -3160,7 +3160,7 @@ }, "radiusServerSecret": { "type": "string", - "description": "The radius secret property of the P2SVpnServerConfiguration resource for for point to site client connection." + "description": "The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection." }, "provisioningState": { "readOnly": true, @@ -3219,7 +3219,7 @@ "description": "URL to get the next set of operation list results if there are any." } } - }, + }, "VpnClientConnectionHealth": { "properties": { "totalIngressBytesTransferred": { @@ -3248,7 +3248,7 @@ } }, "description": "VpnClientConnectionHealth properties" - }, + }, "P2SVpnGatewayProperties": { "properties": { "virtualHub": { @@ -3275,7 +3275,7 @@ "vpnClientConnectionHealth": { "readOnly": true, "$ref": "#/definitions/VpnClientConnectionHealth", - "description": "All P2S vpnclients' connection health status." + "description": "All P2S VPN clients' connection health status." } }, "description": "Parameters for P2SVpnGateway" @@ -3301,7 +3301,7 @@ } ], "description": "P2SVpnGateway Resource." - }, + }, "ListP2SVpnGatewaysResult": { "description": "Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.", "properties": { @@ -3343,6 +3343,6 @@ } }, "description": "Vpn Profile Response for package generation" - } + } } } diff --git a/specification/network/resource-manager/readme.go.md b/specification/network/resource-manager/readme.go.md index e4700c19d430..e8ce139c0b5c 100644 --- a/specification/network/resource-manager/readme.go.md +++ b/specification/network/resource-manager/readme.go.md @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2018-12 + - tag: package-2018-11 - tag: package-2018-10 - tag: package-2018-08 - tag: package-2018-07 @@ -44,6 +45,15 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-11' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-11-01/$(namespace) +``` + ### Tag: package-2018-10 and go These settings apply only when `--tag=package-2018-10 --go` is specified on the command line. diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index 87861a12a106..64d390eafd02 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -19,6 +19,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: - tag: package-2018-12 + - tag: package-2018-11 - tag: package-2018-10 - tag: package-2018-08 - tag: package-2018-07 @@ -48,6 +49,17 @@ python: output-folder: $(python-sdks-folder)/azure-mgmt-network/azure/mgmt/network/v2018_12_01 ``` +### Tag: package-2018-11 and python + +These settings apply only when `--tag=package-2018-11 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-11' && $(python) +python: + namespace: azure.mgmt.network.v2018_11_01 + output-folder: $(python-sdks-folder)/azure-mgmt-network/azure/mgmt/network/v2018_11_01 +``` + ### Tag: package-2018-10 and python These settings apply only when `--tag=package-2018-10 --python` is specified on the command line. 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 1e5b84d939d5..49041f0ede1b 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 @@ -681,7 +681,7 @@ "Workspaces" ], "x-ms-examples": { - "SharedKeysList": { "$ref": "./examples/WorkspacesRegenerateSharedKeys.json" } + "RegenerateSharedKeys": { "$ref": "./examples/WorkspacesRegenerateSharedKeys.json" } }, "operationId": "Workspaces_RegenerateSharedKeys", "description": "Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.", @@ -709,6 +709,40 @@ } } }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/gateways/{gatewayId}": { + "delete": { + "tags": [ + "Workspaces" + ], + "x-ms-examples": { + "DeleteGateways": { "$ref": "./examples/WorkspacesGatewaysDelete.json" } + }, + "operationId": "Workspaces_DeleteGateways", + "description": "Delete a Log Analytics gateway.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/GatewayIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The specified gateway was deleted successfully." + } + } + } + }, "/providers/Microsoft.OperationalInsights/operations": { "get": { "tags": [ @@ -1487,6 +1521,14 @@ "type": "string", "description": "In a purge status request, this is the Id of the operation the status of which is returned.", "x-ms-parameter-location": "client" + }, + "GatewayIdParameter": { + "name": "gatewayId", + "in": "path", + "required": true, + "type": "string", + "description": "The Log Analytics gateway Id.", + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesGatewaysDelete.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesGatewaysDelete.json new file mode 100644 index 000000000000..340a389ea117 --- /dev/null +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/examples/WorkspacesGatewaysDelete.json @@ -0,0 +1,13 @@ +{ + "parameters":{ + "subscriptionId":"00000000-0000-0000-0000-00000000000", + "resourceGroupName":"OIAutoRest5123", + "workspaceName":"aztest5048", + "gatewayId":"00000000-0000-0000-0000-00000000000", + "api-version":"2015-03-02" + }, + "responses":{ + "200":{ + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndAggregateOnly.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndAggregateOnly.json new file mode 100644 index 000000000000..4fcc6ac51319 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndAggregateOnly.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview", + "$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/preview/2018-07-01-preview/examples/PolicyStates_FilterAndGroupByWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndGroupByWithAggregate.json new file mode 100644 index 000000000000..11574b7afa35 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndGroupByWithAggregate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview", + "$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/preview/2018-07-01-preview/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json new file mode 100644 index 000000000000..57ab2cf53a13 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview", + "$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/preview/2018-07-01-preview/examples/PolicyStates_FilterAndMultipleGroups.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndMultipleGroups.json new file mode 100644 index 000000000000..72b7f24e1c09 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_FilterAndMultipleGroups.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview", + "$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/preview/2018-07-01-preview/examples/PolicyStates_GetMetadata.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_GetMetadata.json new file mode 100644 index 000000000000..243f3ef67de0 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_GetMetadata.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_ListOperations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_ListOperations.json new file mode 100644 index 000000000000..fde95b67be92 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_ListOperations.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QueryManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryManagementGroupScope.json new file mode 100644 index 000000000000..f42b7d750123 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryManagementGroupScope.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2018-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QueryNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryNestedResourceScope.json new file mode 100644 index 000000000000..7c41461ed920 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..64dd190c3361 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupScope.json new file mode 100644 index 000000000000..ce9eb2692a22 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupScope.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScope.json new file mode 100644 index 000000000000..f70fdf4a8563 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json new file mode 100644 index 000000000000..b7e3ea191a3c --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "api-version": "2018-07-01-preview", + "$expand": "policyEvaluationDetails" + }, + "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, + "complianceState": "NonCompliant", + "policyEvaluationDetails": { + "evaluatedExpressions": [ + { + "result": "True", + "expression": "type", + "path": "type", + "expressionValue": "Microsoft.ClassicCompute/domainNames", + "targetValue": "Microsoft.ClassicCompute/domainNames", + "operator": "Equals" + }, + { + "result": "False", + "expression": "name", + "path": "name", + "expressionValue": "myDomainName", + "targetValue": "someName", + "operator": "Equals" + } + ] + } + }, + { + "@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/test2", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/AuditIfNotExistsTest", + "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": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "AuditIfNotExists test", + "policyDefinitionAction": "auditifnotexists", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyEvaluationDetails": { + "evaluatedExpressions": [ + { + "result": "False", + "expression": "name", + "path": "name", + "expressionValue": "myDomainName", + "targetValue": "someName", + "operator": "Equals" + } + ], + "ifNotExistsDetails": { + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "totalResources": 1 + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json new file mode 100644 index 000000000000..637963528da3 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..c8f4789aa3b1 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..f64b514f299e --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json new file mode 100644 index 000000000000..5b2734f5ca0e --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json new file mode 100644 index 000000000000..fc4d370ddf7d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionScope.json new file mode 100644 index 000000000000..44c5cce101bc --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview" + }, + "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/preview/2018-07-01-preview/examples/PolicyStates_SummarizeManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeManagementGroupScope.json new file mode 100644 index 000000000000..1af9f1f5d331 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeManagementGroupScope.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2018-07-01-preview", + "$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-07-01-preview&$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/preview/2018-07-01-preview/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..6de6b2c7ba44 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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/preview/2018-07-01-preview/examples/PolicyStates_SummarizeResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeResourceGroupScope.json new file mode 100644 index 000000000000..40e5acdb8cd8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeResourceGroupScope.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-07-01-preview" + }, + "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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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/preview/2018-07-01-preview/examples/PolicyStates_SummarizeResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeResourceScope.json new file mode 100644 index 000000000000..4dd9b0ebc4bb --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..ceb06b37a1c0 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..adf0fff51c2a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview" + }, + "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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json new file mode 100644 index 000000000000..62de2e9ba540 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/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-07-01-preview", + "$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-07-01-preview&$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/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionScope.json new file mode 100644 index 000000000000..df8b17e9016e --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_SummarizeSubscriptionScope.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview", + "$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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-07-01-preview&$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/preview/2018-07-01-preview/examples/PolicyStates_TimeRangeSortSelectTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_TimeRangeSortSelectTop.json new file mode 100644 index 000000000000..67daad9e9a5d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_TimeRangeSortSelectTop.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview", + "$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/preview/2018-07-01-preview/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyStates.json new file mode 100644 index 000000000000..9195fd5a6021 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyStates.json @@ -0,0 +1,1605 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyStatesClient", + "version": "2018-07-01-preview" + }, + "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" + }, + { + "$ref": "#/parameters/expandParameter" + } + ], + "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" }, + "Query all policy states at resource scope and expand policyEvaluationDetails": { "$ref": "./examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.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 separated 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" + }, + "complianceState": { + "description": "Compliance state of the resource.", + "type": "string" + }, + "policyEvaluationDetails": { + "description": "Policy evaluation details.", + "type": "object", + "$ref": "#/definitions/PolicyEvaluationDetails" + } + }, + "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" + } + }, + "PolicyEvaluationDetails": { + "type": "object", + "description": "Policy evaluation details.", + "properties": { + "evaluatedExpressions": { + "description": "Details of the evaluated expressions.", + "type": "array", + "items": { + "$ref": "#/definitions/ExpressionEvaluationDetails" + } + }, + "ifNotExistsDetails": { + "description": "Evaluation details of IfNotExists effect.", + "type": "object", + "$ref": "#/definitions/IfNotExistsEvaluationDetails" + } + } + }, + "ExpressionEvaluationDetails": { + "type": "object", + "description": "Evaluation details of policy language expressions.", + "properties": { + "result": { + "description": "Evaluation result.", + "type": "string" + }, + "expression": { + "description": "Expression evaluated.", + "type": "string" + }, + "path": { + "description": "Property path if the expression is a field or an alias.", + "type": "string" + }, + "expressionValue": { + "description": "Value of the expression.", + "type": "string" + }, + "targetValue": { + "description": "Target value to be compared with the expression value.", + "type": "string" + }, + "operator": { + "description": "Operator to compare the expression value and the target value.", + "type": "string" + } + } + }, + "IfNotExistsEvaluationDetails": { + "type": "object", + "description": "Evaluation details of IfNotExists effect.", + "properties": { + "resourceId": { + "description": "ID of the last evaluated resource for IfNotExists effect.", + "type": "string" + }, + "totalResources": { + "description": "Total number of resources to which the existence condition is applicable.", + "type": "integer" + } + } + }, + "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", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "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" + }, + "expandParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter. For example, to expand policyEvaluationDetails, use $expand=policyEvaluationDetails", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Expand" + } + } +} diff --git a/specification/policyinsights/resource-manager/readme.md b/specification/policyinsights/resource-manager/readme.md index f57d8b086041..1578d675bd00 100644 --- a/specification/policyinsights/resource-manager/readme.md +++ b/specification/policyinsights/resource-manager/readme.md @@ -66,7 +66,7 @@ input-file: - Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json - Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json - Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json -- Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json +- Microsoft.PolicyInsights/preview/2018-07-01-preview/policyStates.json ``` diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerCreate.json index 406a3136f1c1..d48932d9e6d1 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerCreate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerCreate.json @@ -18,10 +18,10 @@ "createMode": "Default" }, "sku": { - "name": "SkuName", + "name": "B_Gen5_2", "tier": "Basic", "capacity": 2, - "family": "Gen4" + "family": "Gen5" }, "tags": { "ElasticServer": "1" @@ -37,8 +37,8 @@ "location": "eastus", "sku": { "capacity": 2, - "family": "Gen4", - "name": "PGSQL_B_Gen4_2", + "family": "Gen5", + "name": "B_Gen5_2", "size": null, "tier": "Basic" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreate.json index 9c3e8901184a..3fbb869baf84 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreate.json @@ -18,10 +18,10 @@ "createMode": "Default" }, "sku": { - "name": "B_Gen4_2", + "name": "B_Gen5_2", "tier": "Basic", "capacity": 2, - "family": "Gen4" + "family": "Gen5" }, "tags": { "ElasticServer": "1" @@ -32,9 +32,9 @@ "201": { "body": { "sku": { - "name": "B_Gen4_2", + "name": "B_Gen5_2", "tier": "Basic", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { @@ -62,9 +62,9 @@ "200": { "body": { "sku": { - "name": "B_Gen4_2", + "name": "B_Gen5_2", "tier": "Basic", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreateGeoRestoreMode.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreateGeoRestoreMode.json index edef65a0916e..4931cad298ee 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreateGeoRestoreMode.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreateGeoRestoreMode.json @@ -5,15 +5,15 @@ "api-version": "2017-12-01", "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "parameters": { - "location": "Japan West", + "location": "westus", "properties": { "createMode": "GeoRestore", "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/SourceResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/sourceserver" }, "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "tags": { @@ -25,9 +25,9 @@ "201": { "body": { "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { @@ -55,9 +55,9 @@ "200": { "body": { "sku": { - "name": "GP_Gen4_2", + "name": "GP_Gen5_2", "tier": "GeneralPurpose", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreatePointInTimeRestore.json index 3e55b3c13d0c..c6be2799e954 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreatePointInTimeRestore.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/ServerCreatePointInTimeRestore.json @@ -12,10 +12,10 @@ "sourceServerId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/SourceResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/sourceserver" }, "sku": { - "name": "B_Gen4_2", + "name": "B_Gen5_2", "tier": "Basic", "capacity": 2, - "family": "Gen4" + "family": "Gen5" }, "tags": { "ElasticServer": "1" @@ -26,9 +26,9 @@ "201": { "body": { "sku": { - "name": "B_Gen4_2", + "name": "B_Gen5_2", "tier": "Basic", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { @@ -56,9 +56,9 @@ "200": { "body": { "sku": { - "name": "B_Gen4_2", + "name": "B_Gen5_2", "tier": "Basic", - "family": "Gen4", + "family": "Gen5", "capacity": 2 }, "properties": { diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/operations.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/operations.json index 458e5bb952b9..543b6c97cda4 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/operations.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/operations.json @@ -38,7 +38,6 @@ } } }, - "deprecated": false, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" 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 77db7348d5d7..5bd52620e350 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 @@ -50,7 +50,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Vault Security Config": { "$ref": "./examples/Common/BackupResourceVaultConfigs_Get.json" @@ -97,7 +96,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Update Vault Security Config": { "$ref": "./examples/Common/BackupResourceVaultConfigs_Patch.json" @@ -151,7 +149,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSBackupEnginesQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -216,7 +213,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSBackupEngineQueryObject", "x-ms-examples": { "Get Dpm/AzureBackupServer/Lajolla Backup Engine Details": { @@ -271,7 +267,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Azure Vm Discovery Operation Result": { "$ref": "./examples/Common/RefreshContainers_OperationResults.json" @@ -305,7 +300,6 @@ { "name": "fabricName", "in": "path", - "description": "Fabric name associated with the container.", "required": true, "type": "string" }, @@ -325,7 +319,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSContainerQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -383,7 +376,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Protection Container Details": { "$ref": "./examples/AzureWorkload/ProtectionContainers_Get.json" @@ -394,7 +386,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\r\n the operation.", + "description": "Registers the container with Recovery Services vault.\r\nThis is an asynchronous operation. To track the operation status, use location header to call get latest status of\r\nthe operation.", "operationId": "ProtectionContainers_Register", "produces": [ "application/json" @@ -447,7 +439,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-examples": { "RegisterAzure Storage ProtectionContainers": { "$ref": "./examples/AzureStorage/ProtectionContainers_Register.json" @@ -458,7 +449,7 @@ "tags": [ "ProtectionContainers" ], - "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.", + "description": "Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine\r\nwhether the backend service has finished processing the request, call Get Container Operation Result API.", "operationId": "ProtectionContainers_Unregister", "produces": [ "application/json" @@ -499,7 +490,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Unregister Protection Container": { "$ref": "./examples/AzureWorkload/ProtectionContainers_Unregister.json" @@ -558,7 +548,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSContainersInquiryQueryObject", "x-ms-examples": { "Inquire Azure Storage Protection Containers": { @@ -572,7 +561,7 @@ "tags": [ "BackupWorkloadItems" ], - "description": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination\r\n parameters.", + "description": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination\r\nparameters.", "operationId": "BackupWorkloadItems_List", "produces": [ "application/json" @@ -627,7 +616,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSWorkloadItemQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -698,7 +686,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Get Azure Storage Protection Container Operation Result": { "$ref": "./examples/AzureStorage/ProtectionContainers_Inquire_Result.json" @@ -711,7 +698,7 @@ "tags": [ "ProtectedItems" ], - "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.", + "description": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,\r\ncall the GetItemOperationResult API.", "operationId": "ProtectedItems_Get", "produces": [ "application/json" @@ -766,7 +753,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/GetProtectedItemQueryObject", "x-ms-examples": { "Get Protected Classic Virtual Machine Details": { @@ -781,7 +767,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\r\n 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\nasynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", "operationId": "ProtectedItems_CreateOrUpdate", "produces": [ "application/json" @@ -841,7 +827,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-examples": { "Enable Protection on Azure IaasVm": { "$ref": "./examples/AzureIaasVm/ConfigureProtection.json" @@ -855,7 +840,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\r\n 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\nrequest, call the GetItemOperationResult API.", "operationId": "ProtectedItems_Delete", "produces": [ "application/json" @@ -903,7 +888,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Delete Protection from Azure Virtual Machine": { "$ref": "./examples/Common/ProtectedItem_Delete.json" @@ -916,7 +900,7 @@ "tags": [ "Backups" ], - "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.", + "description": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the\r\noperation, call GetProtectedItemOperationResult API.", "operationId": "Backups_Trigger", "produces": [ "application/json" @@ -970,7 +954,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-examples": { "Trigger Backup": { "$ref": "./examples/Common/TriggerBackup_Post.json" @@ -1044,7 +1027,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Get Operation Results of Protected Vm": { "$ref": "./examples/AzureIaasVm/ProtectedItemOperationResults.json" @@ -1057,7 +1039,7 @@ "tags": [ "ProtectedItemOperationStatuses" ], - "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.", + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations\r\ncreate jobs. This method returns the list of jobs associated with the operation.", "operationId": "ProtectedItemOperationStatuses_Get", "produces": [ "application/json" @@ -1112,7 +1094,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Operation Status of Protected Vm": { "$ref": "./examples/AzureIaasVm/ProtectedItemOperationStatus.json" @@ -1180,7 +1161,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSRPQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -1197,7 +1177,7 @@ "tags": [ "RecoveryPoints" ], - "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.", + "description": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation.\r\nTo know the status of the operation, call the GetProtectedItemOperationResult API.", "operationId": "RecoveryPoints_Get", "produces": [ "application/json" @@ -1252,7 +1232,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Azure Vm Recovery Point Details": { "$ref": "./examples/AzureIaasVm/RecoveryPoints_Get.json" @@ -1265,7 +1244,7 @@ "tags": [ "ItemLevelRecoveryConnections" ], - "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.", + "description": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file\r\nexplorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of\r\nprovisioning, call GetProtectedItemOperationResult API.", "operationId": "ItemLevelRecoveryConnections_Provision", "produces": [ "application/json" @@ -1307,7 +1286,7 @@ { "name": "recoveryPointId", "in": "path", - "description": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\n for this backed up data.", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\nfor this backed up data.", "required": true, "type": "string" }, @@ -1326,7 +1305,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-examples": { "Provision Instant Item Level Recovery for Azure Vm": { "$ref": "./examples/AzureIaasVm/Provision_Ilr.json" @@ -1339,7 +1317,7 @@ "tags": [ "Restores" ], - "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.", + "description": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use\r\nGetProtectedItemOperationResult API.", "operationId": "Restores_Trigger", "produces": [ "application/json" @@ -1400,7 +1378,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-examples": { "Restore to New Azure IaasVm": { "$ref": "./examples/AzureIaasVm/TriggerRestore_ALR.json" @@ -1416,7 +1393,7 @@ "tags": [ "ItemLevelRecoveryConnections" ], - "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.", + "description": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer\r\ndisplaying all recoverable files and folders. This is an asynchronous operation.", "operationId": "ItemLevelRecoveryConnections_Revoke", "produces": [ "application/json" @@ -1458,7 +1435,7 @@ { "name": "recoveryPointId", "in": "path", - "description": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\n this backed up data.", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\nthis backed up data.", "required": true, "type": "string" } @@ -1468,7 +1445,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-examples": { "Revoke Instant Item Level Recovery for Azure Vm": { "$ref": "./examples/AzureIaasVm/Revoke_Ilr.json" @@ -1481,7 +1457,7 @@ "tags": [ "ProtectionContainers" ], - "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.", + "description": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an\r\nasynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.", "operationId": "ProtectionContainers_Refresh", "produces": [ "application/json" @@ -1519,7 +1495,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSRefreshContainersQueryObject", "x-ms-examples": { "Trigger Azure Vm Discovery": { @@ -1533,7 +1508,7 @@ "tags": [ "JobCancellations" ], - "description": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call\r\n GetCancelOperationResult API.", + "description": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call\r\nGetCancelOperationResult API.", "operationId": "JobCancellations_Trigger", "produces": [ "application/json" @@ -1564,7 +1539,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-examples": { "Cancel Job": { "$ref": "./examples/Common/TriggerCancelJob.json" @@ -1577,7 +1551,7 @@ "tags": [ "JobOperationResults" ], - "description": "Fetches the result of any operation.\r\n the operation.", + "description": "Fetches the result of any operation.\r\nthe operation.", "operationId": "JobOperationResults_Get", "produces": [ "application/json" @@ -1621,7 +1595,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Cancel Job Operation Result": { "$ref": "./examples/Common/CancelJobOperationResult.json" @@ -1634,7 +1607,7 @@ "tags": [ "BackupOperationResults" ], - "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.", + "description": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the\r\nstatus code in the response would be Accepted. It will continue to be in this state till it reaches completion. On\r\nsuccessful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is\r\npart of the Location header of the operation response.", "operationId": "BackupOperationResults_Get", "produces": [ "application/json" @@ -1671,7 +1644,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Get Result for Protected Item Delete Operation": { "$ref": "./examples/Common/ProtectedItem_Delete_OperationResult.json" @@ -1684,7 +1656,7 @@ "tags": [ "BackupOperationStatuses" ], - "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.", + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations\r\ncreate jobs. This method returns the list of jobs when the operation is complete.", "operationId": "BackupOperationStatuses_Get", "produces": [ "application/json" @@ -1718,7 +1690,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Protected Item Delete Operation Status": { "$ref": "./examples/Common/ProtectedItem_Delete_OperationStatus.json" @@ -1731,7 +1702,7 @@ "tags": [ "ProtectionPolicies" ], - "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.", + "description": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous\r\noperation. Status of the operation can be fetched using GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_Get", "produces": [ "application/json" @@ -1765,7 +1736,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Azure IaasVm Protection Policy Details": { "$ref": "./examples/AzureIaasVm/ProtectionPolicies_Get.json" @@ -1776,7 +1746,7 @@ "tags": [ "ProtectionPolicies" ], - "description": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched\r\n using GetPolicyOperationResult API.", + "description": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched\r\nusing GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_CreateOrUpdate", "produces": [ "application/json" @@ -1822,7 +1792,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-examples": { "Create or Update Simple Azure Vm Protection Policy": { "$ref": "./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json" @@ -1839,7 +1808,7 @@ "tags": [ "ProtectionPolicies" ], - "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.", + "description": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the\r\noperation can be fetched using GetPolicyOperationResult API.", "operationId": "ProtectionPolicies_Delete", "produces": [ "application/json" @@ -1873,7 +1842,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Delete Azure Vm Protection Policy": { "$ref": "./examples/AzureIaasVm/ProtectionPolicies_Delete.json" @@ -1927,7 +1895,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Protection Policy Operation Results": { "$ref": "./examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json" @@ -1940,7 +1907,7 @@ "tags": [ "ProtectionPolicyOperationStatuses" ], - "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.", + "description": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations\r\ncreate jobs. This method returns the list of jobs associated with operation.", "operationId": "ProtectionPolicyOperationStatuses_Get", "produces": [ "application/json" @@ -1981,7 +1948,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Protection Policy Operation Status": { "$ref": "./examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json" @@ -1994,7 +1960,7 @@ "tags": [ "BackupProtectableItems" ], - "description": "Provides a pageable list of protectable objects within your subscription according to the query filter and the\r\n pagination parameters.", + "description": "Provides a pageable list of protectable objects within your subscription according to the query filter and the\r\npagination parameters.", "operationId": "BackupProtectableItems_List", "produces": [ "application/json" @@ -2035,7 +2001,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSPOQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -2086,7 +2051,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSContainerQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -2130,7 +2094,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Vault Security Pin": { "$ref": "./examples/Common/BackupSecurityPin_Get.json" @@ -2170,19 +2133,64 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Vault Storage Configuration": { "$ref": "./examples/Common/BackupStorageConfig_Get.json" } } }, - "patch": { + "put": { "tags": [ "BackupResourceStorageConfigs" ], "description": "Updates vault storage model type.", "operationId": "BackupResourceStorageConfigs_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Vault storage config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + } + }, + "x-ms-examples": { + "Update Vault Storage Configuration": { + "$ref": "./examples/Common/BackupStorageConfig_Put.json" + } + } + }, + "patch": { + "tags": [ + "BackupResourceStorageConfigs" + ], + "description": "Updates vault storage model type.", + "operationId": "BackupResourceStorageConfigs_Patch", "parameters": [ { "$ref": "#/parameters/ApiVersion" @@ -2211,7 +2219,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Update Vault Storage Configuration": { "$ref": "./examples/Common/BackupStorageConfig_Patch.json" @@ -2226,47 +2233,9 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProtectionContainer" + "$ref": "#/definitions/DpmContainer" } ], - "properties": { - "canReRegister": { - "description": "Specifies whether the container is re-registrable.", - "type": "boolean" - }, - "containerId": { - "description": "ID of container.", - "type": "string" - }, - "protectedItemCount": { - "format": "int64", - "description": "Number of protected items in the BackupEngine", - "type": "integer" - }, - "dpmAgentVersion": { - "description": "Backup engine Agent version", - "type": "string" - }, - "dpmServers": { - "description": "List of BackupEngines protecting the container", - "type": "array", - "items": { - "type": "string" - } - }, - "upgradeAvailable": { - "description": "To check if upgrade available", - "type": "boolean" - }, - "protectionStatus": { - "description": "Protection status of the container.", - "type": "string" - }, - "extendedInfo": { - "$ref": "#/definitions/DPMContainerExtendedInfo", - "description": "Extended Info of the container." - } - }, "x-ms-discriminator-value": "AzureBackupServerContainer" }, "AzureBackupServerEngine": { @@ -2437,7 +2406,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -2482,7 +2452,8 @@ "description": "Contains Url to the snapshot of fileshare, if applicable", "type": "string" } - } + }, + "x-ms-discriminator-value": "AzureFileShareRecoveryPoint" }, "AzureFileShareRestoreRequest": { "description": "AzureFileShare Restore Request", @@ -2948,7 +2919,8 @@ "description": "For instance or AG, indicates number of DBs to be protected", "type": "integer" } - } + }, + "x-ms-discriminator-value": "AzureVmWorkloadItem" }, "AzureVmWorkloadProtectableItem": { "description": "Azure VM workload-specific protectable item.", @@ -2964,7 +2936,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\nOnly Applicable for data bases where the parent would be either Instance or a SQL AG.", "type": "string" }, "serverName": { @@ -2993,7 +2965,8 @@ "$ref": "#/definitions/PreBackupValidation", "description": "Pre-backup validation for protectable objects" } - } + }, + "x-ms-discriminator-value": "AzureVmWorkloadProtectableItem" }, "AzureVmWorkloadProtectedItem": { "description": "Azure VM workload-specific protected item.", @@ -3086,7 +3059,8 @@ "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", "description": "Additional information for this backup item." } - } + }, + "x-ms-discriminator-value": "AzureVmWorkloadProtectedItem" }, "AzureVmWorkloadProtectedItemExtendedInfo": { "description": "Additional information on Azure Workload for SQL specific backup item.", @@ -3133,7 +3107,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -3155,8 +3130,58 @@ }, "x-ms-discriminator-value": "AzureWorkload" }, + "AzureVmWorkloadSAPAseDatabaseProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP ASE Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPAseDatabase" + }, + "AzureVmWorkloadSAPAseDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP ASE Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPAseDatabase" + }, + "AzureVmWorkloadSAPAseDatabaseWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP ASE Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPAseDatabase" + }, + "AzureVmWorkloadSAPAseSystemProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP ASE System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPAseSystem" + }, + "AzureVmWorkloadSAPAseSystemWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP ASE System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPAseSystem" + }, "AzureVmWorkloadSAPHanaDatabaseProtectableItem": { - "description": "Azure VM workload-specific protectable item representing SAP Hana Database.", + "description": "Azure VM workload-specific protectable item representing SAP HANA Database.", "type": "object", "allOf": [ { @@ -3166,7 +3191,7 @@ "x-ms-discriminator-value": "SAPHanaDatabase" }, "AzureVmWorkloadSAPHanaDatabaseProtectedItem": { - "description": "Azure VM workload-specific protected item representing SAP Hana Database.", + "description": "Azure VM workload-specific protected item representing SAP HANA Database.", "type": "object", "allOf": [ { @@ -3176,7 +3201,7 @@ "x-ms-discriminator-value": "AzureVmWorkloadSAPHanaDatabase" }, "AzureVmWorkloadSAPHanaDatabaseWorkloadItem": { - "description": "Azure VM workload-specific workload item representing SAP Hana Database.", + "description": "Azure VM workload-specific workload item representing SAP HANA Database.", "type": "object", "allOf": [ { @@ -3186,7 +3211,7 @@ "x-ms-discriminator-value": "SAPHanaDatabase" }, "AzureVmWorkloadSAPHanaSystemProtectableItem": { - "description": "Azure VM workload-specific protectable item representing SAP Hana System.", + "description": "Azure VM workload-specific protectable item representing SAP HANA System.", "type": "object", "allOf": [ { @@ -3196,7 +3221,7 @@ "x-ms-discriminator-value": "SAPHanaSystem" }, "AzureVmWorkloadSAPHanaSystemWorkloadItem": { - "description": "Azure VM workload-specific workload item representing SAP Hana System.", + "description": "Azure VM workload-specific workload item representing SAP HANA System.", "type": "object", "allOf": [ { @@ -3230,93 +3255,9 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProtectedItem" + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" } ], - "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 DB, SQLAG or StandAlone", - "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." - } - }, "x-ms-discriminator-value": "AzureVmWorkloadSQLDatabase" }, "AzureVmWorkloadSQLDatabaseWorkloadItem": { @@ -3432,16 +3373,30 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { "name": "WorkloadType", "modelAsString": true } + }, + "operationType": { + "description": "Re-Do Operation", + "enum": [ + "Invalid", + "Register", + "Reregister" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true + } } }, - "x-ms-discriminator-value": "AzureWorkloadBackupRequest" + "x-ms-discriminator-value": "AzureWorkloadContainer" }, "AzureWorkloadContainerExtendedInfo": { "description": "Extended information of the container.", @@ -3464,6 +3419,42 @@ } } }, + "AzureWorkloadPointInTimeRecoveryPoint": { + "description": "Recovery point specific to PointInTime", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRecoveryPoint" + } + ], + "properties": { + "timeRanges": { + "description": "List of log ranges", + "type": "array", + "items": { + "$ref": "#/definitions/PointInTimeRange" + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadPointInTimeRecoveryPoint" + }, + "AzureWorkloadPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadPointInTimeRestoreRequest" + }, "AzureWorkloadRecoveryPoint": { "description": "Workload specific recovery point, specifically encapsulates full/diff recovery point", "type": "object", @@ -3528,6 +3519,10 @@ "additionalProperties": { "type": "string" } + }, + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" } }, "x-ms-discriminator-value": "AzureWorkloadRestoreRequest" @@ -3537,18 +3532,9 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/AzureWorkloadSAPHanaRecoveryPoint" + "$ref": "#/definitions/AzureWorkloadPointInTimeRecoveryPoint" } ], - "properties": { - "timeRanges": { - "description": "List of log ranges", - "type": "array", - "items": { - "$ref": "#/definitions/PointInTimeRange" - } - } - }, "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRecoveryPoint" }, "AzureWorkloadSAPHanaPointInTimeRestoreRequest": { @@ -3573,30 +3559,9 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/RecoveryPoint" + "$ref": "#/definitions/AzureWorkloadRecoveryPoint" } ], - "properties": { - "recoveryPointTimeInUTC": { - "format": "date-time", - "description": "UTC time at which recovery point was created", - "type": "string" - }, - "type": { - "description": "Type of restore point", - "enum": [ - "Invalid", - "Full", - "Log", - "Differential" - ], - "type": "string", - "x-ms-enum": { - "name": "RestorePointType", - "modelAsString": true - } - } - }, "x-ms-discriminator-value": "AzureWorkloadSAPHanaRecoveryPoint" }, "AzureWorkloadSAPHanaRestoreRequest": { @@ -3604,40 +3569,9 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/AzureWorkloadRestoreRequest" } ], - "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": { @@ -3687,7 +3621,7 @@ "properties": { "extendedInfo": { "$ref": "#/definitions/AzureWorkloadSQLRecoveryPointExtendedInfo", - "description": "Extended Info that provides data directory details. Will be populated in two cases:\r\n When a specific recovery point is accessed using GetRecoveryPoint\r\n Or when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter" + "description": "Extended Info that provides data directory details. Will be populated in two cases:\r\nWhen a specific recovery point is accessed using GetRecoveryPoint\r\nOr when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter" } }, "x-ms-discriminator-value": "AzureWorkloadSQLRecoveryPoint" @@ -3727,10 +3661,6 @@ "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", @@ -4229,7 +4159,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -4278,7 +4209,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -4391,7 +4323,9 @@ "SQLInstance", "SQLDataBase", "SAPHanaSystem", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseSystem", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -4415,7 +4349,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -4461,7 +4396,7 @@ "type": "string" }, "scriptNameSuffix": { - "description": "Mandator suffix that should be added to the name of script that is given for download to user.\r\n If its null or empty then , ignore it.", + "description": "Mandatory suffix that should be added to the name of script that is given for download to user.\r\nIf its null or empty then , ignore it.", "type": "string" } } @@ -4543,7 +4478,7 @@ "type": "string" }, "status": { - "description": "Status of this Node.\r\n Failed | Succeeded", + "description": "Status of this Node.\r\nFailed | Succeeded", "type": "string" }, "errorDetail": { @@ -5024,7 +4959,8 @@ "description": "Fully qualified ARM ID of the virtual machine.", "type": "string" } - } + }, + "x-ms-discriminator-value": "IaaSVMProtectableItem" }, "IaasVMRecoveryPoint": { "description": "IaaS VM workload specific backup copy.", @@ -5122,11 +5058,11 @@ "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}", + "description": "This is the complete ARM Id of the VM that will be created.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}", "type": "string" }, "targetResourceGroupId": { - "description": "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\n For e.g. /subscriptions/{subId}/resourcegroups/{rg}", + "description": "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}", "type": "string" }, "storageAccountId": { @@ -5134,15 +5070,15 @@ "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.", + "description": "This is the virtual network Id of the vnet that will be attached to the virtual machine.\r\nUser will be validated for join action permissions in the linked access.", "type": "string" }, "subnetId": { - "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\n 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\nthe subnet.", "type": "string" }, "targetDomainNameId": { - "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\n 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\nVirtual Machines.", "type": "string" }, "region": { @@ -5154,7 +5090,7 @@ "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.", + "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\ncloud service as it was at the time of backup.", "type": "boolean" }, "originalStorageAccountOption": { @@ -5201,7 +5137,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\nInProgress | Failed | Succeeded", "type": "string" }, "errorDetail": { @@ -5209,7 +5145,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\nFor e.g. - For SQL and oracle this will contain different details.", "type": "array", "items": { "$ref": "#/definitions/WorkloadInquiryDetails" @@ -5263,7 +5199,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 following 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 potentially have different vault ids.", + "description": "BEK is bitlocker key.\r\nKEK is encryption key for BEK\r\nIf the VM was encrypted then we will store following details :\r\n1. Secret(BEK) - Url + Backup Data + vaultId.\r\n2. Key(KEK) - Url + Backup Data + vaultId.\r\n3. EncryptionMechanism\r\nBEK and KEK can potentially have different vault ids.", "type": "object", "properties": { "kekDetails": { @@ -5332,7 +5268,8 @@ { "$ref": "#/definitions/SchedulePolicy" } - ] + ], + "x-ms-discriminator-value": "LongTermSchedulePolicy" }, "MabContainer": { "description": "Container with items backed up using MAB backup engine.", @@ -5404,7 +5341,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -5576,10 +5514,6 @@ } } }, - "Object": { - "description": "Base of all objects.", - "type": "object" - }, "OperationStatus": { "description": "Operation status.", "type": "object", @@ -5784,7 +5718,7 @@ } }, "protectableContainerType": { - "description": "Type of the container. The value of this property for\r\n 1. Compute Azure VM is Microsoft.Compute/virtualMachines\r\n 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines", + "description": "Type of the container. The value of this property for\r\n1. Compute Azure VM is Microsoft.Compute/virtualMachines\r\n2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines", "enum": [ "Invalid", "Unknown", @@ -5895,7 +5829,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -5990,7 +5925,7 @@ "type": "string" }, "containerType": { - "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", + "description": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer", "enum": [ "Invalid", "Unknown", @@ -6260,7 +6195,7 @@ "properties": { "count": { "format": "int32", - "description": "Count of duration types. Retention duration is obtained by the counting the duration type Count times.\r\n For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.", + "description": "Count of duration types. Retention duration is obtained by the counting the duration type Count times.\r\nFor example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.", "type": "integer" }, "durationType": { @@ -6321,7 +6256,7 @@ "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.", + "description": "Workload compression flag. This has been added so that 'isSqlCompression'\r\nwill be deprecated once clients upgrade to consider this flag.", "type": "boolean" } } @@ -6868,16 +6803,16 @@ "in": "path", "description": "The name of the resource group where the recovery services vault is present.", "required": true, - "x-ms-parameter-location": "method", - "type": "string" + "type": "string", + "x-ms-parameter-location": "method" }, "VaultName": { "name": "vaultName", "in": "path", "description": "The name of the recovery services vault.", "required": true, - "x-ms-parameter-location": "method", - "type": "string" + "type": "string", + "x-ms-parameter-location": "method" }, "ApiVersion": { "name": "api-version", diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/examples/Common/BackupStorageConfig_Put.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/examples/Common/BackupStorageConfig_Put.json new file mode 100644 index 000000000000..7adaa9e34cfb --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/examples/Common/BackupStorageConfig_Put.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "api-version": "2016-12-01", + "parameters": { + "properties": { + "storageType": "LocallyRedundant", + "storageTypeState": "Unlocked" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupstorageconfig/vaultstorageconfig", + "name": "vaultstorageconfig", + "type": "Microsoft.RecoveryServices/vaults/backupstorageconfig", + "properties": { + "storageModelType": "LocallyRedundant", + "storageType": "LocallyRedundant", + "dedupState": "Disabled", + "xcoolState": "Disabled", + "storageTypeState": "Unlocked" + } + } + } + } +} \ No newline at end of file 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 05b64e835732..913497bcd5de 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 @@ -23,7 +23,7 @@ "tags": [ "ProtectionIntent" ], - "summary": "It will validate followings\r\n 1. Vault capacity\r\n 2. VM is already protected\r\n 3. Any VM related configuration passed in properties.", + "summary": "It will validate followings\r\n1. Vault capacity\r\n2. VM is already protected\r\n3. Any VM related configuration passed in properties.", "operationId": "ProtectionIntent_Validate", "produces": [ "application/json" @@ -56,7 +56,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Validate Enable Protection on Azure Vm": { "$ref": "./examples/AzureIaasVm/ProtectionIntent_Validate.json" @@ -102,7 +101,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Azure Virtual Machine Backup Status": { "$ref": "./examples/AzureIaasVm/GetBackupStatus.json" @@ -148,7 +146,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Check Azure Vm Backup Feature Support": { "$ref": "./examples/AzureIaasVm/BackupFeature_Validate.json" @@ -161,7 +158,7 @@ "tags": [ "ProtectionIntent" ], - "description": "Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation,\r\n call the GetItemOperationResult API.", + "description": "Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation,\r\ncall the GetItemOperationResult API.", "operationId": "ProtectionIntent_Get", "produces": [ "application/json" @@ -202,7 +199,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get ProtectionIntent for an item": { "$ref": "./examples/AzureWorkload/BackupProtectionIntent_Get.json" @@ -263,7 +259,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Create or Update Azure Vm Protection Intent": { "$ref": "./examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json" @@ -312,7 +307,6 @@ "description": "NoContent" } }, - "deprecated": false, "x-ms-examples": { "Delete Protection intent from item": { "$ref": "./examples/AzureWorkload/BackupProtectionIntent_Delete.json" @@ -366,7 +360,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/JobQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -423,7 +416,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Get Job Details": { "$ref": "./examples/Common/GetJobDetails.json" @@ -436,7 +428,7 @@ "tags": [ "ExportJobsOperationResults" ], - "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.", + "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also\r\ncontains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", "operationId": "ExportJobsOperationResults_Get", "produces": [ "application/json" @@ -476,7 +468,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Export Jobs Operation Results": { "$ref": "./examples/Common/ExportJobsOperationResult.json" @@ -520,7 +511,6 @@ "description": "Accepted" } }, - "deprecated": false, "x-ms-odata": "#/definitions/JobQueryObject", "x-ms-examples": { "Export Jobs": { @@ -534,7 +524,7 @@ "tags": [ "BackupPolicies" ], - "description": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch\r\n scoped results.", + "description": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch\r\nscoped results.", "operationId": "BackupPolicies_List", "produces": [ "application/json" @@ -568,7 +558,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/ProtectionPolicyQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -629,7 +618,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/ProtectedItemQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -687,7 +675,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/ProtectionIntentQueryObject", "x-ms-pageable": { "nextLinkName": "nextLink" @@ -745,7 +732,6 @@ } } }, - "deprecated": false, "x-ms-odata": "#/definitions/BMSBackupSummariesQueryObject", "x-ms-pageable": { "nextLinkName": null @@ -801,7 +787,6 @@ } } }, - "deprecated": false, "x-ms-examples": { "Validate Operation": { "$ref": "./examples/AzureIaasVm/ValidateOperation_RestoreDisk.json" @@ -929,7 +914,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -1218,7 +1204,7 @@ "type": "number" }, "taskExecutionDetails": { - "description": "Details about execution of the task.\r\n eg: number of bytes transferred etc", + "description": "Details about execution of the task.\r\neg: number of bytes transferred etc", "type": "string" } } @@ -1519,7 +1505,8 @@ "$ref": "#/definitions/AzureStorageJobExtendedInfo", "description": "Additional information about the job." } - } + }, + "x-ms-discriminator-value": "AzureStorageJob" }, "AzureStorageJobExtendedInfo": { "description": "Azure Storage workload-specific additional information for job.", @@ -1691,7 +1678,8 @@ "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", "description": "Additional information for this backup item." } - } + }, + "x-ms-discriminator-value": "AzureVmWorkloadProtectedItem" }, "AzureVmWorkloadProtectedItemExtendedInfo": { "description": "Additional information on Azure Workload for SQL specific backup item.", @@ -1738,7 +1726,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -1760,8 +1749,18 @@ }, "x-ms-discriminator-value": "AzureWorkload" }, + "AzureVmWorkloadSAPAseDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP ASE Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPAseDatabase" + }, "AzureVmWorkloadSAPHanaDatabaseProtectedItem": { - "description": "Azure VM workload-specific protected item representing SAP Hana Database.", + "description": "Azure VM workload-specific protected item representing SAP HANA Database.", "type": "object", "allOf": [ { @@ -1775,93 +1774,9 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProtectedItem" + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" } ], - "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 DB, SQLAG or StandAlone", - "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." - } - }, "x-ms-discriminator-value": "AzureVmWorkloadSQLDatabase" }, "AzureWorkloadAutoProtectionIntent": { @@ -1949,7 +1864,8 @@ "$ref": "#/definitions/AzureWorkloadJobExtendedInfo", "description": "Additional information about the job." } - } + }, + "x-ms-discriminator-value": "AzureWorkloadJob" }, "AzureWorkloadJobExtendedInfo": { "description": "Azure VM workload-specific additional information for job.", @@ -1989,6 +1905,23 @@ } } }, + "AzureWorkloadPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadPointInTimeRestoreRequest" + }, "AzureWorkloadRestoreRequest": { "description": "AzureWorkload-specific restore.", "type": "object", @@ -2022,6 +1955,10 @@ "additionalProperties": { "type": "string" } + }, + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" } }, "x-ms-discriminator-value": "AzureWorkloadRestoreRequest" @@ -2048,40 +1985,9 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/AzureWorkloadRestoreRequest" } ], - "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": { @@ -2100,7 +2006,9 @@ "SQLInstance", "SQLDataBase", "SAPHanaSystem", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseSystem", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -2145,10 +2053,6 @@ "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", @@ -2237,7 +2141,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -2274,6 +2179,10 @@ "modelAsString": true } }, + "vaultId": { + "description": "Specifies the arm resource id of the vault", + "type": "string" + }, "fabricName": { "description": "Specifies the fabric name - Azure or AD", "enum": [ @@ -2811,11 +2720,11 @@ "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}", + "description": "This is the complete ARM Id of the VM that will be created.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}", "type": "string" }, "targetResourceGroupId": { - "description": "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\n For e.g. /subscriptions/{subId}/resourcegroups/{rg}", + "description": "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}", "type": "string" }, "storageAccountId": { @@ -2823,15 +2732,15 @@ "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.", + "description": "This is the virtual network Id of the vnet that will be attached to the virtual machine.\r\nUser will be validated for join action permissions in the linked access.", "type": "string" }, "subnetId": { - "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n {VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\n 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\nthe subnet.", "type": "string" }, "targetDomainNameId": { - "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\n 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\nVirtual Machines.", "type": "string" }, "region": { @@ -2843,7 +2752,7 @@ "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.", + "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\ncloud service as it was at the time of backup.", "type": "boolean" }, "originalStorageAccountOption": { @@ -3074,7 +2983,8 @@ { "$ref": "#/definitions/SchedulePolicy" } - ] + ], + "x-ms-discriminator-value": "LongTermSchedulePolicy" }, "MabErrorInfo": { "description": "MAB workload-specific error information.", @@ -3230,7 +3140,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -3378,10 +3289,6 @@ } } }, - "Object": { - "description": "Base of all objects.", - "type": "object" - }, "OperationResultInfo": { "description": "Operation result info.", "type": "object", @@ -3503,7 +3410,7 @@ } }, "PreValidateEnableBackupRequest": { - "description": "Contract to validate if backup can be enabled on the given resource in a given vault and given configuration.\r\n It will validate followings\r\n 1. Vault capacity\r\n 2. VM is already protected\r\n 3. Any VM related configuration passed in properties.", + "description": "Contract to validate if backup can be enabled on the given resource in a given vault and given configuration.\r\nIt will validate followings\r\n1. Vault capacity\r\n2. VM is already protected\r\n3. Any VM related configuration passed in properties.", "type": "object", "properties": { "resourceType": { @@ -3522,7 +3429,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -3534,6 +3442,10 @@ "description": "ARM Virtual Machine Id", "type": "string" }, + "vaultId": { + "description": "Specifies the arm resource id of the vault", + "type": "string" + }, "properties": { "description": "Configuration of VM if any needs to be validated like OS type etc", "type": "string" @@ -3570,7 +3482,7 @@ "type": "string" }, "containerName": { - "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required\r\n for portal", + "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required\r\nfor portal", "type": "string" }, "protectedItemName": { @@ -3622,7 +3534,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -3720,7 +3633,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -3983,7 +3897,8 @@ "GenericDataSource", "SQLDataBase", "AzureFileShare", - "SAPHanaDatabase" + "SAPHanaDatabase", + "SAPAseDatabase" ], "type": "string", "x-ms-enum": { @@ -4110,7 +4025,7 @@ "properties": { "count": { "format": "int32", - "description": "Count of duration types. Retention duration is obtained by the counting the duration type Count times.\r\n For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.", + "description": "Count of duration types. Retention duration is obtained by the counting the duration type Count times.\r\nFor example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.", "type": "integer" }, "durationType": { @@ -4171,7 +4086,7 @@ "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.", + "description": "Workload compression flag. This has been added so that 'isSqlCompression'\r\nwill be deprecated once clients upgrade to consider this flag.", "type": "boolean" } } @@ -4574,8 +4489,8 @@ "in": "path", "description": "Azure region to hit Api", "required": true, - "x-ms-parameter-location": "method", - "type": "string" + "type": "string", + "x-ms-parameter-location": "method" }, "ApiVersion": { "name": "api-version", @@ -4589,16 +4504,16 @@ "in": "path", "description": "The name of the resource group where the recovery services vault is present.", "required": true, - "x-ms-parameter-location": "method", - "type": "string" + "type": "string", + "x-ms-parameter-location": "method" }, "VaultName": { "name": "vaultName", "in": "path", "description": "The name of the recovery services vault.", "required": true, - "x-ms-parameter-location": "method", - "type": "string" + "type": "string", + "x-ms-parameter-location": "method" } }, "securityDefinitions": { diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json index 804c01c8a889..6f0323509895 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json @@ -462,7 +462,7 @@ }, "level": { "type": "string", - "description": "Level of event.", + "description": "Level of insight.", "enum": [ "Critical", "Warning" @@ -472,6 +472,19 @@ "modelAsString": true } }, + "eventLevel": { + "type": "string", + "description": "Level of event.", + "enum": [ + "Critical", + "Warning", + "Informational" + ], + "x-ms-enum": { + "name": "EventLevelValues", + "modelAsString": true + } + }, "article": { "type": "object", "description": "Article of event.", @@ -538,6 +551,27 @@ "items": { "$ref": "#/definitions/faq" } + }, + "isHIR": { + "type": "boolean", + "description": "It provides information if the event is High incident rate event or not." + }, + "enableMicrosoftSupport": { + "type": "boolean", + "description": "Tells if we want to enable or disable Microsoft Support for this event." + }, + "enableChatWithUs": { + "type": "boolean", + "description": "Tells if we want to enable or disable Microsoft Support for this event." + }, + "priority": { + "type": "integer", + "description": "Priority level of the event." + }, + "lastUpdateTime": { + "type": "string", + "description": "It provides the Timestamp for when the health impacting event was last updated.", + "format": "date-time" } } } @@ -1094,4 +1128,4 @@ "description": "EventId for the Service health event" } } -} \ No newline at end of file +} diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySingleResource.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySingleResource.json index 39b04f525301..0033f6a6c542 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySingleResource.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySingleResource.json @@ -1,92 +1,98 @@ -{ - "parameters": { - "resourceUri": "subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.Compute/virtualMachines/rhctestenvV1PI", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ", - "name": "BC_1-FXZ", - "type": "/providers/Microsoft.ResourceHealth/events", - "properties": { - "eventType": "ServiceIssue", - "eventSource": "ResourceHealth", - "status": "Active", - "title": "ACTIVE: Virtual machines in West US", - "summary": "An outage alert is being investigated. More information will be provided as it is known.", - "header": "Your service might have been impacted by an Azure service issue", - "article": { - "articleContent": "An outage alert is being investigated. More information will be provided as it is known" - }, - "links": [ - { - "type": "Hyperlink", - "displayText": { - "value": "Request RCA", - "localizedValue": "Request RCA" - }, - "extensionName": "Microsoft_Azure_Health", - "bladeName": "RequestRCABlade", - "parameters": { - "trackingId": "BC_1-FXZ", - "rcaRequested": "False" - } - }, - { - "type": "Button", - "displayText": { - "value": "Sign up for updates", - "localizedValue": "Sign up for updates" - }, - "extensionName": "Microsoft_Azure_Health", - "bladeName": "AzureHealthBrowseBlade", - "parameters": { - "trackingId": "BC_1-FXZ" - } - } - ], - "level": "Warning", - "impactStartTime": "2018-11-07T00:00:00Z", - "impactMitigationTime": "2018-11-08T00:00:00Z", - "impact": [ - { - "impactedService": "Virtual Machines", - "impactedRegions": [ - { - "impactedRegion": "West US", - "status": "Active", - "impactedSubscriptions": [ - "{subscriptionId}" - ], - "lastUpdateTime": "2017-12-05T21:05:00Z" - } - ] - } - ], - "recommendedActions": { - "groupId": 2343, - "title": "Recommended actions title", - "actions": [ - "action 1", - "action 2" - ], - "localeCode": "en" - }, - "faqs": [ - { - "question": "This is a question", - "answer": "This is an answer", - "localeCode": "en" - } - ] - } - } - ], - "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" - } - } - } -} \ No newline at end of file +{ + "parameters": { + "resourceUri": "subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.Compute/virtualMachines/rhctestenvV1PI", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ", + "name": "BC_1-FXZ", + "type": "/providers/Microsoft.ResourceHealth/events", + "properties": { + "eventType": "ServiceIssue", + "eventSource": "ResourceHealth", + "status": "Active", + "title": "ACTIVE: Virtual machines in West US", + "summary": "An outage alert is being investigated. More information will be provided as it is known.", + "header": "Your service might have been impacted by an Azure service issue", + "article": { + "articleContent": "An outage alert is being investigated. More information will be provided as it is known" + }, + "links": [ + { + "type": "Hyperlink", + "displayText": { + "value": "Request RCA", + "localizedValue": "Request RCA" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "RequestRCABlade", + "parameters": { + "trackingId": "BC_1-FXZ", + "rcaRequested": "False" + } + }, + { + "type": "Button", + "displayText": { + "value": "Sign up for updates", + "localizedValue": "Sign up for updates" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "AzureHealthBrowseBlade", + "parameters": { + "trackingId": "BC_1-FXZ" + } + } + ], + "level": "Warning", + "eventLevel": "Informational", + "impactStartTime": "2018-11-07T00:00:00Z", + "impactMitigationTime": "2018-11-08T00:00:00Z", + "impact": [ + { + "impactedService": "Virtual Machines", + "impactedRegions": [ + { + "impactedRegion": "West US", + "status": "Active", + "impactedSubscriptions": [ + "{subscriptionId}" + ], + "lastUpdateTime": "2017-12-05T21:05:00Z" + } + ] + } + ], + "recommendedActions": { + "groupId": 2343, + "title": "Recommended actions title", + "actions": [ + "action 1", + "action 2" + ], + "localeCode": "en" + }, + "faqs": [ + { + "question": "This is a question", + "answer": "This is an answer", + "localeCode": "en" + } + ], + "isHIR": false, + "enableMicrosoftSupport": true, + "enableChatWithUs": false, + "priority": 2, + "lastUpdateTime": "2018-11-08T00:00:00Z" + } + } + ], + "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" + } + } + } +} diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySubscriptionId.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySubscriptionId.json index 1576d5ba2b77..f320566aad72 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySubscriptionId.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySubscriptionId.json @@ -1,93 +1,99 @@ -{ - "parameters": { - "subscriptionId": "subscriptionId", - "api-version": "2018-07-01-preview", - "$filter": "service eq 'Virtual Machines' or region eq 'West US'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ", - "name": "BC_1-FXZ", - "type": "/providers/Microsoft.ResourceHealth/events", - "properties": { - "eventType": "ServiceIssue", - "eventSource": "ResourceHealth", - "status": "Active", - "title": "ACTIVE: Virtual machines in West US", - "summary": "An outage alert is being investigated. More information will be provided as it is known.", - "header": "Your service might have been impacted by an Azure service issue", - "article": { - "articleContent": "An outage alert is being investigated. More information will be provided as it is known" - }, - "links": [ - { - "type": "Hyperlink", - "displayText": { - "value": "Request RCA", - "localizedValue": "Request RCA" - }, - "extensionName": "Microsoft_Azure_Health", - "bladeName": "RequestRCABlade", - "parameters": { - "trackingId": "BC_1-FXZ", - "rcaRequested": "False" - } - }, - { - "type": "Button", - "displayText": { - "value": "Sign up for updates", - "localizedValue": "Sign up for updates" - }, - "extensionName": "Microsoft_Azure_Health", - "bladeName": "AzureHealthBrowseBlade", - "parameters": { - "trackingId": "BC_1-FXZ" - } - } - ], - "level": "Warning", - "impactStartTime": "2018-11-07T00:00:00Z", - "impactMitigationTime": "2018-11-08T00:00:00Z", - "impact": [ - { - "impactedService": "Virtual Machines", - "impactedRegions": [ - { - "impactedRegion": "West US", - "status": "Active", - "impactedSubscriptions": [ - "{subscriptionId}" - ], - "lastUpdateTime": "2017-12-05T21:05:00Z" - } - ] - } - ], - "recommendedActions": { - "groupId": 2343, - "title": "Recommended actions title", - "actions": [ - "action 1", - "action 2" - ], - "localeCode": "en" - }, - "faqs": [ - { - "question": "This is a question", - "answer": "This is an answer", - "localeCode": "en" - } - ] - } - } - ], - "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" - } - } - } -} \ No newline at end of file +{ + "parameters": { + "subscriptionId": "subscriptionId", + "api-version": "2018-07-01-preview", + "$filter": "service eq 'Virtual Machines' or region eq 'West US'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ", + "name": "BC_1-FXZ", + "type": "/providers/Microsoft.ResourceHealth/events", + "properties": { + "eventType": "ServiceIssue", + "eventSource": "ResourceHealth", + "status": "Active", + "title": "ACTIVE: Virtual machines in West US", + "summary": "An outage alert is being investigated. More information will be provided as it is known.", + "header": "Your service might have been impacted by an Azure service issue", + "article": { + "articleContent": "An outage alert is being investigated. More information will be provided as it is known" + }, + "links": [ + { + "type": "Hyperlink", + "displayText": { + "value": "Request RCA", + "localizedValue": "Request RCA" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "RequestRCABlade", + "parameters": { + "trackingId": "BC_1-FXZ", + "rcaRequested": "False" + } + }, + { + "type": "Button", + "displayText": { + "value": "Sign up for updates", + "localizedValue": "Sign up for updates" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "AzureHealthBrowseBlade", + "parameters": { + "trackingId": "BC_1-FXZ" + } + } + ], + "level": "Warning", + "eventLevel": "Informational", + "impactStartTime": "2018-11-07T00:00:00Z", + "impactMitigationTime": "2018-11-08T00:00:00Z", + "impact": [ + { + "impactedService": "Virtual Machines", + "impactedRegions": [ + { + "impactedRegion": "West US", + "status": "Active", + "impactedSubscriptions": [ + "{subscriptionId}" + ], + "lastUpdateTime": "2017-12-05T21:05:00Z" + } + ] + } + ], + "recommendedActions": { + "groupId": 2343, + "title": "Recommended actions title", + "actions": [ + "action 1", + "action 2" + ], + "localeCode": "en" + }, + "faqs": [ + { + "question": "This is a question", + "answer": "This is an answer", + "localeCode": "en" + } + ], + "isHIR": false, + "enableMicrosoftSupport": true, + "enableChatWithUs": false, + "priority": 2, + "lastUpdateTime": "2018-11-08T00:00:00Z" + } + } + ], + "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/CreateResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/CreateResourceGroup.json new file mode 100644 index 000000000000..312f1ceba2f5 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/examples/CreateResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-05-01", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup", + "name": "myResourceGroup", + "location": "eastus", + "properties": { + "provisioningState":"Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup", + "name": "myResourceGroup", + "location": "eastus", + "properties": { + "provisioningState":"Succeeded" + } + } + } + } +} 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 index e1fcaa1e7733..48e2023c77a2 100644 --- 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 @@ -1014,6 +1014,9 @@ "tags": [ "ResourceGroups" ], + "x-ms-examples": { + "Create or update a resource group": { "$ref": "./examples/CreateResourceGroup.json" } + }, "operationId": "ResourceGroups_CreateOrUpdate", "description": "Creates or updates a resource group.", "parameters": [ 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/SearchIndexAutocompleteDocumentsGet.json similarity index 100% rename from specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetAutocomplete.json rename to specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexAutocompleteDocumentsGet.json 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/SearchIndexAutocompleteDocumentsPost.json similarity index 94% rename from specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexPostAutocomplete.json rename to specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexAutocompleteDocumentsPost.json index 9bf10af1cee4..e693f6f07de8 100644 --- 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/SearchIndexAutocompleteDocumentsPost.json @@ -11,7 +11,7 @@ "highlightPostTag": "", "highlightPreTag": "", "minimumCoverage": 80, - "searchFields": ["title", "description"], + "searchFields": "title,description", "top": 10 } }, diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..50738b071d51 --- /dev/null +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetDocument.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "searchServiceName": "myservice", + "searchDnsSuffix": "search.windows.net", + "indexName": "myindex", + "api-version": "2017-11-11-Preview", + "key": "1", + "$select": ["docId", "title", "description"] + }, + "responses": { + "200": { + "body": { + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + } + } + } +} \ 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 index a1792858a7a3..f9b1ff57fcc8 100644 --- 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 @@ -34,16 +34,16 @@ "/docs/$count": { "get": { "tags": [ - "DocumentsProxy" + "Documents" ], - "operationId": "DocumentsProxy_Count", + "operationId": "Documents_Count", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Count-Documents" + }, "x-ms-examples": { "SearchIndexCountDocuments": { "$ref": "./examples/SearchIndexCountDocuments.json" } }, "description": "Queries the number of documents in the Azure Search index.", - "externalDocs": { - "url": "https://docs.microsoft.com/rest/api/searchservice/Count-Documents" - }, "parameters": [ { "$ref": "#/parameters/ClientRequestIdParameter" @@ -64,14 +64,65 @@ } } }, + "/docs('{key}')": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Get", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/lookup-document" + }, + "x-ms-examples": { + "SearchIndexGetDocument": { "$ref": "./examples/SearchIndexGetDocument.json" } + }, + "description": "Retrieves a document from the Azure Search index.", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "description": "The key of the document to retrieve.", + "type": "string" + }, + { + "name":"$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.", + "x-ms-client-name": "SelectedFields" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object" + } + } + } + } + }, "/docs/autocomplete": { "get": { "tags": [ - "Autocomplete" + "Documents" ], - "operationId": "DocumentsProxy_AutocompleteGet", + "operationId": "Documents_AutocompleteGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, "x-ms-examples": { - "SearchIndexGetAutocomplete": { "$ref": "./examples/SearchIndexGetAutocomplete.json" } + "SearchIndexAutocompleteDocumentsGet": { "$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json" } }, "description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.", "parameters": [ @@ -147,7 +198,7 @@ "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.", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", "x-ms-parameter-grouping": { "name": "AutocompleteParameters" } @@ -188,11 +239,14 @@ }, "post": { "tags": [ - "Autocomplete" + "Documents" ], - "operationId": "DocumentsProxy_AutocompletePost", + "operationId": "Documents_AutocompletePost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, "x-ms-examples": { - "SearchIndexPostAutocomplete": { "$ref": "./examples/SearchIndexPostAutocomplete.json" } + "SearchIndexAutocompleteDocumentsPost": { "$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json" } }, "description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.", "parameters": [ @@ -203,7 +257,7 @@ "$ref": "#/parameters/ApiVersionParameter" }, { - "name": "AutocompleteRequest", + "name": "autocompleteRequest", "in": "body", "required": true, "schema": { @@ -353,7 +407,7 @@ "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." + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, 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", @@ -364,7 +418,7 @@ "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)." + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\"(without the quotes)." }, "scoringProfile": { "type": "string", @@ -375,7 +429,7 @@ "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." + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents." }, "searchFields": { "type": "string", @@ -434,7 +488,7 @@ "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." + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, 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", @@ -487,7 +541,7 @@ "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." + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." }, "searchFields": { "type": "string", 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 9c98b43f7ef8..9bc5169457cd 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md @@ -101,3 +101,53 @@ csharp: clear-output-folder: true output-folder: $(csharp-sdks-folder)/Search/DataPlane/Microsoft.Azure.Search.Data/Generated ``` + +### Tweak generated code + +Use the below directives sparingly. Every modification we make in here, we potentially have to replicate for every target language. + +``` yaml $(csharp) +directive: + # Rename the IDocumentsOperations interface and implementation, then make the interface internal so we can version it freely. + # This requires these changes: + # 1. Globally rename the interface and implementation class, along with comments and constructors + # 2. Make the interface itself internal + # 3. Make the SearchIndexClient.Documents property internal and rename it to DocumentsProxy + # 4. Rename the type of the ISearchIndexClient.Documents property back to IDocumentsOperations, effectively removing the + # generated property from the interface (this reverses step 1 above just for this case) + # + # The ISearchIndexClient.Documents property is of type IDocumentsOperations, which is hand-written and delegates to DocumentsProxy. + # This allows us to do two things: + # 1. Abstract away the detail of whether GET or POST is used for read operations (Search, Suggest, etc.) + # 2. Add methods with type parameters and custom serialization to make our SDK easier to use in strongly-typed scenarios + # (i.e. -- where the customer is using a class to represent their model because its schema is known at design-time) + - from: source-file-csharp + where: $ + transform: >- + return $. + replace( /DocumentsOperations/g, "DocumentsProxyOperations" ). + replace( /public (partial interface IDocumentsProxyOperations)/g, "internal $1" ). + replace( /public virtual (IDocumentsProxyOperations) Documents ({ get;)/g, "internal $1 DocumentsProxy $2" ). + replace( /Documents = new DocumentsProxyOperations\(this\);/g, "DocumentsProxy = new DocumentsProxyOperations\(this\);" ). + replace( /(Gets the) IDocumentsProxyOperations(.\s*\n\s*\/\/\/ <\/summary>\s*\n\s*)IDocumentsProxyOperations (Documents { get; })/g, "$1 IDocumentsOperations$2IDocumentsOperations $3" ) +#### + # Adds extra JsonSerializerSettings parameters to all operation methods. This enables the SDK to delegate serialization/de-serialization to the custom serializer on a per-call basis. + - from: source-file-csharp + where: $ + transform: >- + return $. + replace( /(Async\(.*, CancellationToken cancellationToken = default\(CancellationToken\))/g, "$1, Newtonsoft.Json.JsonSerializerSettings requestSerializerSettings = null, Newtonsoft.Json.JsonSerializerSettings responseDeserializerSettings = null" ). + replace( /(DeserializeObject<.+>\(.+), Client\.DeserializationSettings/g, "$1, responseDeserializerSettings ?? Client.DeserializationSettings" ). + replace( /(SerializeObject\(.+), Client\.SerializationSettings/g , "$1, requestSerializerSettings ?? Client.SerializationSettings" ) +#### + # Make GetWithHttpMessagesAsync generic so we can tell the deserializer what type to instantiate. + # ASSUMPTION: Only GetWithHttpMessagesAsync makes a call to DeserializeObject(), and only when it's deserializing the non-error response. + # Ideally we'd be able to more finely target these transform rules. + - from: source-file-csharp + where: $ + transform: >- + return $. + replace( /(Task(> GetWithHttpMessagesAsync)/g, "$1$2" ). + replace( /(DeserializeObject)/g, "$1" ). + replace( /(var _result = new AzureOperationResponse)/g, "$1" ) +``` 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 index 8c97f972bc3b..d9dcb26bed85 100644 --- 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 @@ -566,49 +566,14 @@ } } }, - "/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" - } - } - } - }, + "/skillsets('{skillsetName}')": { "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.", + "description": "Creates a new cognitive skillset in an Azure Search service or updates the skillset if it already exists.", "externalDocs": { "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" }, @@ -656,7 +621,7 @@ } }, "delete": { - "tags": ["skillsetName"], + "tags": ["Skillsets"], "operationId": "Skillsets_Delete", "x-ms-examples": { "SearchServiceDeleteSkillset": { "$ref": "./examples/SearchServiceDeleteSkillset.json" } @@ -689,6 +654,41 @@ "description": "The provided skillset name is not found." } } + }, + "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" + } + } + } } }, "/skillsets": { @@ -718,15 +718,13 @@ "$ref": "#/definitions/SkillsetListResult" } } - } + } }, "post": { "tags": ["Skillsets"], "operationId": "Skillsets_Create", "x-ms-examples": { - "SearchServiceCreateSkillset": { - "$ref": "./examples/SearchServiceCreateSkillset.json" - } + "SearchServiceCreateSkillset": { "$ref": "./examples/SearchServiceCreateSkillset.json" } }, "description": "Creates a new cognitive skillset in an Azure Search service.", "externalDocs": { @@ -3432,7 +3430,7 @@ "type": "string", "description": "The name of the datasource from which this indexer reads data." }, - "skillsetName": { + "skillsetName": { "type": "string", "description": "The name of the cognitive skillset executing with this indexer." }, @@ -3458,7 +3456,7 @@ "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" } }, - "outputFieldMappings": { + "outputFieldMappings": { "type": "array", "items": { "$ref": "#/definitions/FieldMapping" @@ -4027,10 +4025,10 @@ "enum": [ "analyzingInfixMatching" ], - "x-ms-enum": { - "name": "searchMode", - "modelAsString": false - }, + "x-ms-enum": { + "name": "searchMode", + "modelAsString": false + }, "description": "A value indicating the capabilities of the suggester." }, "sourceFields": { @@ -4168,433 +4166,544 @@ }, "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 + "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." + }, + "cognitiveServices": { + "$ref": "#/definitions/CognitiveServices", + "description": "Details about cognitive services to be used when running skills." + }, + "@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." + }, + "CognitiveServices": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base class for describing any cognitive service resource attached to the skillset." + }, + "DefaultCognitiveServices": { + "description": "An empty object that represents the default cognitive service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServices" + } + ] + }, + "CognitiveServicesByKey": { + "description": "A cognitive service resource provisioned with a key that is attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServices" + } + ], + "properties": { + "key": { + "type": "string" + } + }, + "required": [ + "key" + ] + }, + "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": "A string indicating which named entity categories to return." - }, - "SentimentSkillLanguage": { + "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." + }, + "EntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/Skill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityCategory", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/EntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "includeTypelessEntities": { + "type": "boolean", + "x-nullable": true, + "description": "Determines whether or not to include entities which are well known but don't conform to a type. If this configuration is not set (default), set to null or set to false, entities which don't have a type will not be surfaced." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + }, + "description": "Text analytics entity recognition." + }, + "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. This skill is deprecated in favor of EntityRecognitionSkill.", + "x-ms-external": true + }, + "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." + }, + "EntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person", + "quantity", + "datetime", + "url", + "email" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": false + }, + "description": "A string indicating what entity categories to return." + }, + "NamedEntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person" + ], + "description": "A string indicating which named entity categories to return.", + "x-ms-external": true + }, + "SentimentSkillLanguage": { "properties": { "name": { "type": "string" @@ -4603,7 +4712,7 @@ "description": "The language codes supported for input text by SentimentSkill.", "x-ms-external": true }, - "KeyPhraseExtractionSkillLanguage": { + "KeyPhraseExtractionSkillLanguage": { "properties": { "name": { "type": "string" @@ -4612,7 +4721,7 @@ "description": "The language codes supported for input text by KeyPhraseExtractionSkill.", "x-ms-external": true }, - "OcrSkillLanguage": { + "OcrSkillLanguage": { "properties": { "name": { "type": "string" @@ -4621,7 +4730,7 @@ "description": "The language codes supported for input by OcrSkill.", "x-ms-external": true }, - "SplitSkillLanguage": { + "SplitSkillLanguage": { "properties": { "name": { "type": "string" @@ -4630,7 +4739,16 @@ "description": "The language codes supported for input text by SplitSkill.", "x-ms-external": true }, - "NamedEntityRecognitionSkillLanguage": { + "EntityRecognitionSkillLanguage": { + "properties": { + "name": { + "type": "string" + } + }, + "description": "The language codes supported for input text by EntityRecognitionSkill.", + "x-ms-external": true + }, + "NamedEntityRecognitionSkillLanguage": { "properties": { "name": { "type": "string" @@ -4639,7 +4757,7 @@ "description": "The language codes supported for input text by NamedEntityRecognitionSkill.", "x-ms-external": true }, - "ImageAnalysisSkillLanguage": { + "ImageAnalysisSkillLanguage": { "properties": { "name": { "type": "string" 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 9856ff77f935..f3f7c2a7a25e 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/readme.md @@ -108,7 +108,8 @@ directive: where: $ transform: > if ( $.includes("class DataSourcesOperations") || $.includes("class IndexersOperations") || - $.includes("class IndexesOperations") || $.includes("class SynonymMapsOperations") ) + $.includes("class IndexesOperations") || $.includes("class SynonymMapsOperations") || + $.includes("class SkillsetsOperations") ) return $. replace(/this.SearchServiceName/g,"Client.SearchServiceName"). 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 index f7d1de97b849..440889fab580 100644 --- 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 @@ -45,6 +45,7 @@ "reason": "Some computer reason" }], "canBeInvestigated": true, + "isIncident": false, "entities": [{ "address": "192.0.2.1", "location": { 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 index bcb4d7fd727d..461126f44bf0 100644 --- 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 @@ -44,6 +44,7 @@ "reason": "Some computer reason" }], "canBeInvestigated": true, + "isIncident": false, "entities": [{ "address": "192.0.2.1", "location": { 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 index ddc50444a3f7..b0f23f6f9d0a 100644 --- 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 @@ -45,6 +45,7 @@ "reason": "Some computer reason" }], "canBeInvestigated": true, + "isIncident": false, "entities": [{ "address": "192.0.2.1", "location": { 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 index 415c4dd5a394..6c7008fd58ba 100644 --- 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 @@ -44,6 +44,7 @@ "reason": "Some computer reason" }], "canBeInvestigated": true, + "isIncident": false, "entities": [{ "address": "192.0.2.1", "location": { 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 index b1c6da1dce8a..a9ecacbc0765 100644 --- 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 @@ -43,6 +43,7 @@ "reason": "Some computer reason" }], "canBeInvestigated": true, + "isIncident": false, "entities": [{ "address": "192.0.2.1", "location": { 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 index 506adecf7f6e..d8ea835d6a30 100644 --- 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 @@ -44,6 +44,7 @@ "reason": "Some computer reason" }], "canBeInvestigated": true, + "isIncident": false, "entities": [{ "address": "192.0.2.1", "location": { 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 index 9b3f52583b9e..c3c2eecfbd3a 100644 --- 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 @@ -2017,6 +2017,30 @@ "reportedSeverity": { "readOnly": true, "type": "string", + "enum": [ + "Silent", + "Information", + "Low", + "High" + ], + "x-ms-enum": { + "name": "reportedSeverity", + "modelAsString": true, + "values": [ + { + "value": "Silent" + }, + { + "value": "Information" + }, + { + "value": "Low" + }, + { + "value": "High" + } + ] + }, "description": "Estimated severity of this alert" }, "compromisedEntity": { @@ -2042,6 +2066,11 @@ "type": "boolean", "description": "Whether this alert can be investigated with Azure Security Center" }, + "isIncident": { + "readOnly": true, + "type": "boolean", + "description": "Whether this alert is for incident type or not (otherwise - single alert)" + }, "entities": { "type": "array", "description": "objects that are related to this alerts", 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 index dd28fce11964..13c46c33ed3e 100644 --- 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 @@ -413,7 +413,7 @@ } }, "tags": ["Workspace Settings"], - "description": "Settings about where we should store your security data and logs", + "description": "Settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set", "operationId": "WorkspaceSettings_List", "parameters": [{ "$ref": "#/parameters/ApiVersion" @@ -447,7 +447,7 @@ } }, "tags": ["Workspace Settings"], - "description": "Settings about where we should store your security data and logs", + "description": "Settings about where we should store your security data and logs. If the result is empty, it means that no custom-workspace configuration was set", "operationId": "WorkspaceSettings_Get", "parameters": [{ "$ref": "#/parameters/ApiVersion" diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/GetPricingByName_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/GetPricingByName_example.json new file mode 100644 index 000000000000..3f82b0634aaf --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/GetPricingByName_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "pricingName": "VirtualMachines" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/VirtualMachines", + "name": "VirtualMachines", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/ListPricings_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/ListPricings_example.json new file mode 100644 index 000000000000..9fd70c6ad741 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/ListPricings_example.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/VirtualMachines", + "name": "VirtualMachines", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/SqlServers", + "name": "SqlServers", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/AppServices", + "name": "AppServices", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Free" + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/PutPricingByName_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/PutPricingByName_example.json new file mode 100644 index 000000000000..dc28fe5af600 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/examples/Pricings/PutPricingByName_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-06-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "pricingName": "VirtualMachines", + "pricing": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/VirtualMachines", + "name": "VirtualMachines", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/VirtualMachines", + "name": "VirtualMachines", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/security.json b/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/security.json new file mode 100644 index 000000000000..3073f7d2c049 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2018-06-01/security.json @@ -0,0 +1,278 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "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}/providers/Microsoft.Security/pricings": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/ListPricings_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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}": { + "get": { + "x-ms-examples": { + "Get pricings on subscription": { + "$ref": "./examples/Pricings/GetPricingByName_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the subscription", + "operationId": "Pricings_Get", + "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 pricing on subscription": { + "$ref": "./examples/Pricings/PutPricingByName_example.json" + } + }, + "tags": ["Pricings"], + "description": "Security pricing configuration in the subscription", + "operationId": "Pricings_Update", + "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" + } + } + } + } + } + }, + "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 + }, + "PricingList": { + "description": "List of pricing configurations response", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of pricing configurations", + "items": { + "$ref": "#/definitions/Pricing" + } + } + } + }, + "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 properties for the relevant scope", + "properties": { + "pricingTier": { + "type": "string", + "description": "The pricing tier value", + "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" + } + ] + } + }, + "FreeTrialRemainingTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "The duration left for the subscriptions free trial period - in ISO 8601 format (e.g. P3Y6M4DT12H30M5S)." + } + }, + "required": [ + "pricingTier" + ] + } + }, + "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" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": ["2018-06-01"], + "description": "API version for the operation" + }, + "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" + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertResourceGroupLocation_example.json new file mode 100644 index 000000000000..4f151c844069 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertResourceGroupLocation_example.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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, + "isIncident": false, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertSubscriptionLocation_example.json new file mode 100644 index 000000000000..a83797038f93 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertSubscriptionLocation_example.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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, + "isIncident": false, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupLocation_example.json new file mode 100644 index 000000000000..71f6d8ad8def --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroupLocation_example.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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, + "isIncident": false, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroup_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroup_example.json new file mode 100644 index 000000000000..c73f61d0b36f --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsResourceGroup_example.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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, + "isIncident": false, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscription_example.json new file mode 100644 index 000000000000..74f1c0e26122 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscription_example.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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, + "isIncident": false, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + }, + { + "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/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionsLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionsLocation_example.json new file mode 100644 index 000000000000..7eb3c550c3d8 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/GetAlertsSubscriptionsLocation_example.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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, + "isIncident": false, + "entities": [{ + "address": "192.0.2.1", + "location": { + "countryCode": "gb", + "state": "wokingham", + "city": "sonning", + "longitude": -0.909, + "latitude": 51.468, + "asn": 6584 + }, + "threatIntelligence": [{ + "providerName": "Team Cymru", + "threatType": "C2", + "threatName": "rarog", + "confidence": 0.8, + "reportLink": "http://www.microsoft.com", + "threatDescription": "In bot armies, the controller is the server machine(s) that gives instructions to the controlled (zombied) hosts that connect to the command and control (C2) network. The controller host is usually running a botnet management application that is sending the commands to the zombied members of the bot army. These commands include, but are not limited to, the following: updating bitcoin wallet information, distributed denial-of-service (DDoS) target listings, updated C2 communication contact lists, and targeting data. C2 servers may be either directly controlled by the malware operators or run on hardware compromised by malware. There are multiple techniques for dynamically changing the control servers so that they are not isolated and brought down. Control servers utilize two general architectures: client-server and peer-to-peer. In a client-server model, all the hosts are controlled by a single server or a few control servers. In a peer-to-peer model, the infected hosts are both clients and servers, and they control other hosts so that instead of isolating the few control servers, all the hosts need to be removed." + }], + "type": "ip" + }] + } + }, + { + "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/stable/2019-01-01/examples/Alerts/UpdateAlertResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/UpdateAlertResourceGroupLocation_example.json new file mode 100644 index 000000000000..76854926020d --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/UpdateAlertResourceGroupLocation_example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/stable/2019-01-01/examples/Alerts/UpdateAlertSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/UpdateAlertSubscriptionLocation_example.json new file mode 100644 index 000000000000..8ddb873327c4 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/examples/Alerts/UpdateAlertSubscriptionLocation_example.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "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/stable/2019-01-01/security.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/security.json new file mode 100644 index 000000000000..55698940738a --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-01-01/security.json @@ -0,0 +1,822 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2019-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/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 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" + } + } + } + } + } + }, + "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" + } + } + }, + "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", + "enum": [ + "Informational", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "reportedSeverity", + "modelAsString": true, + "values": [ + { + "value": "Informational" + }, + { + "value": "Low" + }, + { + "value": "Medium" + }, + { + "value": "High" + } + ] + }, + "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" + }, + "isIncident": { + "readOnly": true, + "type": "boolean", + "description": "Whether this alert is for incident type or not (otherwise - single alert)" + }, + "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": true, + "description": "Changing set of properties depending on the entity type.", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "Type of entity" + } + } + }, + "AlertExtendedProperties": { + "type": "object", + "additionalProperties": true, + "description": "Changing set of properties depending on the alert type." + } + }, + "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": [ + "2019-01-01" + ], + "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" + }, + "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" + }, + "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" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json new file mode 100644 index 000000000000..a9424b2c3d1c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -0,0 +1,1110 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.SecurityInsights/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all operations available Azure Security Insights Resource Provider.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved operations list.", + "schema": { + "$ref": "#/definitions/operationsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules": { + "get": { + "x-ms-examples": { + "Get all scheduled alert rules.": { + "$ref": "./examples/alertRules/GetScheduledAlertRules.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets all alert rules.", + "operationId": "AlertRules_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}": { + "get": { + "x-ms-examples": { + "Get a scheduled alert rule.": { + "$ref": "./examples/alertRules/GetScheduledAlertRuleById.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets a alert rule.", + "operationId": "AlertRules_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a scheduled alert rule.": { + "$ref": "./examples/alertRules/CreateScheduledAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Creates or updates the alert rule.", + "operationId": "AlertRules_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/AlertRule" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a scheduled alert rule.": { + "$ref": "./examples/alertRules/DeleteScheduledAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Delete the alert rule.", + "operationId": "AlertRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors": { + "get": { + "x-ms-examples": { + "Get all data connectors.": { + "$ref": "./examples/dataConnectors/GetDataConnectors.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Gets all data connectors.", + "operationId": "DataConnectors_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataConnectorList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}": { + "get": { + "x-ms-examples": { + "Get an Office365 data connector.": { + "$ref": "./examples/dataConnectors/GetOfficeDataConnetorById.json" + }, + "Get a TI data connector.": { + "$ref": "./examples/dataConnectors/GetThreatIntelligenceById.json" + }, + "Get a MCAS data connector.": { + "$ref": "./examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json" + }, + "Get a ASC data connector.": { + "$ref": "./examples/dataConnectors/GetAzureSecurityCenterById.json" + }, + "Get an AAD data connector.": { + "$ref": "./examples/dataConnectors/GetAzureActiveDirectoryById.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Gets a data connector.", + "operationId": "DataConnectors_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an Office365 data connector.": { + "$ref": "./examples/dataConnectors/CreateOfficeDataConnetor.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Creates or updates the data connector.", + "operationId": "DataConnectors_Create", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + }, + { + "$ref": "#/parameters/DataConnector" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an Office365 data connector.": { + "$ref": "./examples/dataConnectors/DeleteOfficeDataConnetor.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Delete the data connector.", + "operationId": "DataConnectors_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/OperationalInsightsResourceProvider" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "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 SecurityInsights RP.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of operations.", + "type": "string" + }, + "value": { + "description": "Array of operations", + "type": "array", + "items": { + "$ref": "#/definitions/operation" + } + } + }, + "required": [ + "value" + ] + }, + "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." + } + } + }, + "AlertRulesList": { + "description": "List all the alert rules.", + "properties": { + "nextLink": { + "readOnly": true, + "description": "URL to fetch the next set of alert rules.", + "type": "string" + }, + "value": { + "description": "Array of alert rules.", + "type": "array", + "items": { + "$ref": "#/definitions/AlertRule" + } + } + }, + "required": [ + "value" + ] + }, + "AlertRule": { + "type": "object", + "description": "Alert rule.", + "discriminator": "kind", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/AlertRuleKind" + } + ], + "properties": { + "etag": { + "type": "string", + "description": "Etag of the alert rule." + } + } + }, + "AlertRuleKind": { + "type": "object", + "description": "Describes an Azure resource with kind.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the alert rule", + "enum": [ + "Scheduled" + ], + "x-ms-enum": { + "name": "AlertRuleKind", + "modelAsString": true, + "values": [ + { + "value": "Scheduled" + } + ] + } + } + } + }, + "ScheduledAlertRule": { + "x-ms-discriminator-value": "Scheduled", + "type": "object", + "description": "Represents scheduled alert rule.", + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Scheduled alert rule properties", + "$ref": "#/definitions/ScheduledAlertRuleProperties" + } + } + }, + "ScheduledAlertRuleProperties": { + "type": "object", + "description": "Alert rule property bag.", + "properties": { + "ruleName": { + "type": "string", + "description": "The name for alerts created by this alert rule." + }, + "description": { + "type": "string", + "description": "The description of the alert rule." + }, + "severity": { + "type": "string", + "enum": [ + "Low", + "Medium", + "High", + "Informational" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": false + }, + "description": "The severity for alerts created by this alert rule." + }, + "enabled": { + "type": "boolean", + "description": "Determines whether this alert rule is enabled or disabled." + }, + "query": { + "type": "string", + "description": "The query that creates alerts for this rule." + }, + "queryFrequency": { + "type": "string", + "format": "duration", + "description": "The frequency (in ISO 8601 duration format) for this alert rule to run." + }, + "queryPeriod": { + "type": "string", + "format": "duration", + "description": "The period (in ISO 8601 duration format) that this alert rule looks at." + }, + "triggerOperator": { + "type": "string", + "enum": [ + "GreaterThan", + "LessThan", + "Equal", + "NotEqual" + ], + "x-ms-enum": { + "name": "TriggerOperator", + "modelAsString": false + }, + "description": "The operation against the threshold that triggers alert rule." + }, + "triggerThreshold": { + "type": "integer", + "description": "The threshold triggers this alert rule." + }, + "suppressionEnabled": { + "type": "boolean", + "description": "Determines whether the suppression for this alert rule is enabled or disabled." + }, + "suppressionDuration": { + "type": "string", + "format": "duration", + "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered." + }, + "lastModifiedUtc": { + "type": "string", + "readOnly": true, + "description": "The last time that this alert has been modified." + } + }, + "required": [ + "ruleName", + "description", + "severity", + "enabled", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold", + "suppressionEnabled", + "suppressionDuration" + ] + }, + "DataConnectorList": { + "description": "List all the data connectors.", + "properties": { + "nextLink": { + "readOnly": true, + "description": "URL to fetch the next set of data connectors.", + "type": "string" + }, + "value": { + "description": "Array of data connectors.", + "type": "array", + "items": { + "$ref": "#/definitions/DataConnector" + } + } + }, + "required": [ + "value" + ] + }, + "DataConnector": { + "type": "object", + "description": "Data connector.", + "discriminator": "kind", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/DataConnectorKind" + } + ], + "properties": { + "etag": { + "type": "string", + "description": "Etag of the data connector." + } + } + }, + "DataConnectorKind": { + "type": "object", + "description": "Describes an Azure resource with kind.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the data connector", + "enum": [ + "AzureActiveDirectory", + "AzureSecurityCenter", + "MicrosoftCloudAppSecurity", + "ThreatIntelligence", + "Office365" + ], + "x-ms-enum": { + "name": "DataConnectorKind", + "modelAsString": true, + "values": [ + { + "value": "AzureActiveDirectory" + }, + { + "value": "AzureSecurityCenter" + }, + { + "value": "MicrosoftCloudAppSecurity" + }, + { + "value": "ThreatIntelligence" + }, + { + "value": "Office365" + } + ] + } + } + } + }, + "DataConnectorContextId": { + "type": "object", + "description": "Describes an Azure resource with kind.", + "properties": { + "contextId": { + "type": "string", + "description": "The context id of the origin data source (Like tenantID, SubscriptionID etc.)." + } + } + }, + "OfficeDataConnector": { + "x-ms-discriminator-value": "Office365", + "type": "object", + "description": "Represents office data connector.", + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Office data connector properties.", + "$ref": "#/definitions/OfficeDataConnectorProperties" + } + } + }, + "OfficeDataConnectorProperties": { + "type": "object", + "description": "Office data connector properties.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorContextId" + } + ], + "properties": { + "dataTypes": { + "description": "The available data types for the connector.", + "$ref": "#/definitions/OfficeDataConnectorDataTypes" + } + } + }, + "OfficeDataConnectorDataTypes": { + "type": "object", + "description": "The available data types for office data connector.", + "properties": { + "sharePoint": { + "type": "object", + "description": "SharePoint data type connection.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ] + }, + "exchange": { + "type": "object", + "description": "Exchange data type connection.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ] + } + } + }, + "TIDataConnector": { + "x-ms-discriminator-value": "ThreatIntelligence", + "type": "object", + "description": "Represents threat intelligence data connector.", + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "TI data connector properties.", + "$ref": "#/definitions/TIDataConnectorProperties" + } + } + }, + "TIDataConnectorProperties": { + "type": "object", + "description": "TI data connector properties.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorContextId" + } + ], + "properties": { + "dataTypes": { + "description": "The available data types for the connector.", + "$ref": "#/definitions/TIDataConnectorDataTypes" + } + } + }, + "TIDataConnectorDataTypes": { + "type": "object", + "description": "The available data types for TI data connector.", + "properties": { + "indicators": { + "type": "object", + "description": "Data type for indicators connection.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ] + } + } + }, + "AADDataConnector": { + "x-ms-discriminator-value": "AzureActiveDirectory", + "type": "object", + "description": "Represents AAD (Azure Active Directory) data connector.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorWithAlerts" + } + ] + }, + "ASCDataConnector": { + "x-ms-discriminator-value": "AzureSecurityCenter", + "type": "object", + "description": "Represents ASC (Azure Security Center) data connector.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorWithAlerts" + } + ] + }, + "MCASDataConnector": { + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity", + "type": "object", + "description": "Represents MCAS (Microsoft Cloud App Security) data connector.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorWithAlerts" + } + ] + }, + "DataConnectorWithAlerts": { + "type": "object", + "description": "Data connector with alerts data type.", + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Data connector properties.", + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + } + }, + "DataConnectorWithAlertsProperties": { + "type": "object", + "description": "Data connector properties.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorContextId" + } + ], + "properties": { + "dataTypes": { + "description": "The available data types for the connector.", + "$ref": "#/definitions/AlertsDataTypeOfDataConnector" + } + } + }, + "AlertsDataTypeOfDataConnector": { + "type": "object", + "description": "Alerts data type for data connectors.", + "properties": { + "alerts": { + "type": "object", + "description": "Alerts data type connection.", + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ] + } + } + }, + "DataConnectorDataTypeCommon": { + "type": "object", + "description": "Common field for data type in data connectors.", + "properties": { + "state": { + "type": "string", + "description": "Describe whether this data type connection is enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DataTypeState", + "modelAsString": true + } + } + } + }, + "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" + } + } + } + }, + "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": [ + "2019-01-01-preview" + ], + "description": "API version for the operation" + }, + "OperationalInsightsResourceProvider": { + "name": "operationalInsightsResourceProvider", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of workspaces resource provider- Microsoft.OperationalInsights.", + "x-ms-parameter-location": "method" + }, + "WorkspaceName": { + "name": "workspaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "RuleId": { + "name": "ruleId", + "in": "path", + "required": true, + "pattern": "^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$", + "type": "string", + "description": "Alert rule ID", + "x-ms-parameter-location": "method" + }, + "AlertRule": { + "name": "alertRule", + "in": "body", + "description": "The alert rule", + "required": true, + "schema": { + "$ref": "#/definitions/AlertRule" + }, + "x-ms-parameter-location": "method" + }, + "DataConnectorId": { + "name": "dataConnectorId", + "in": "path", + "required": true, + "type": "string", + "description": "Connector ID", + "x-ms-parameter-location": "method" + }, + "DataConnector": { + "name": "dataConnector", + "in": "body", + "description": "The data connector", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnector" + }, + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/CreateScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/CreateScheduledAlertRule.json new file mode 100644 index 000000000000..c607352ac94a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/CreateScheduledAlertRule.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "alertRule": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "ruleName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "ruleName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2019-01-01T13:15:30Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "ruleName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false + } + } + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/DeleteScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/DeleteScheduledAlertRule.json new file mode 100644 index 000000000000..17f6dfb42ea8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/DeleteScheduledAlertRule.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + }, + "204":{ + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/GetScheduledAlertRuleById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/GetScheduledAlertRuleById.json new file mode 100644 index 000000000000..78e1755dd733 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/GetScheduledAlertRuleById.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "ruleName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2019-01-01T13:15:30Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/GetScheduledAlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/GetScheduledAlertRules.json new file mode 100644 index 000000000000..57767b28358e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/alertRules/GetScheduledAlertRules.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "ruleName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2019-01-01T13:15:30Z" + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json new file mode 100644 index 000000000000..072359664ddd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json new file mode 100644 index 000000000000..1035c3b37a63 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + }, + "204":{ + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json new file mode 100644 index 000000000000..a3c18427f3b3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "dataConnectorId": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "name": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureActiveDirectory", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json new file mode 100644 index 000000000000..514122ce779d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "dataConnectorId": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureSecurityCenter", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetDataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetDataConnectors.json new file mode 100644 index 000000000000..660e304d8d38 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetDataConnectors.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureSecurityCenter", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "name": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureActiveDirectory", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/b96d014d-b5c2-4a01-9aba-a8058f629d42", + "name": "b96d014d-b5c2-4a01-9aba-a8058f629d42", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftCloudAppSecurity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json new file mode 100644 index 000000000000..ec98b323db72 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "dataConnectorId": "b96d014d-b5c2-4a01-9aba-a8058f629d42" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/b96d014d-b5c2-4a01-9aba-a8058f629d42", + "name": "b96d014d-b5c2-4a01-9aba-a8058f629d42", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftCloudAppSecurity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json new file mode 100644 index 000000000000..686396edd89d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..65e998321202 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-01-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationsManagement/workspaces/myWorkspace/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contextId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/readme.go.md b/specification/securityinsights/resource-manager/readme.go.md new file mode 100644 index 000000000000..639ffd574a13 --- /dev/null +++ b/specification/securityinsights/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: securityinsight + 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/securityinsights/resource-manager/readme.md b/specification/securityinsights/resource-manager/readme.md new file mode 100644 index 000000000000..20aa7f9264db --- /dev/null +++ b/specification/securityinsights/resource-manager/readme.md @@ -0,0 +1,87 @@ +# Security Insight + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for SecurityInsights. + +--- + +## Getting Started + +To build the SDK for SecurityInsights, 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 SecurityInsights 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.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.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-js + - 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.SecurityInsights + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/SecurityInsights/Management.SecurityInsights/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Node.js + +See configuration in [readme.nodejs.md](./readme.nodejs.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) \ No newline at end of file diff --git a/specification/securityinsights/resource-manager/readme.nodejs.md b/specification/securityinsights/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..f4181bc3d488 --- /dev/null +++ b/specification/securityinsights/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-securityinsight + output-folder: $(node-sdks-folder)/lib/services/securityInsightManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/securityinsights/resource-manager/readme.python.md b/specification/securityinsights/resource-manager/readme.python.md new file mode 100644 index 000000000000..1818849662fd --- /dev/null +++ b/specification/securityinsights/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.securityinsight + package-name: azure-mgmt-securityinsight + 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-securityinsight/azure/mgmt/securityinsight +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-securityinsight +``` diff --git a/specification/securityinsights/resource-manager/readme.typescript.md b/specification/securityinsights/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..f361a92f380d --- /dev/null +++ b/specification/securityinsights/resource-manager/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-securityinsight" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-securityinsight" + generate-metadata: true +``` diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetCreate.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetGet.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json index 689deaaf6251..79342ec7a4ad 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json @@ -46,7 +46,7 @@ "description": "Lists all of the available ServiceBus REST API operations.", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" } ], "responses": { @@ -83,10 +83,10 @@ }, "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -123,13 +123,13 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -166,7 +166,7 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "namespaceName", @@ -185,10 +185,10 @@ "description": "Parameters supplied to create a namespace resource." }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -230,16 +230,16 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -275,16 +275,16 @@ }, "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -313,10 +313,10 @@ "description": "Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { "name": "parameters", @@ -328,10 +328,10 @@ "description": "Parameters supplied to update a namespace resource." }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -373,16 +373,16 @@ "description": "Gets a list of IP Filter rules for a Namespace.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -418,13 +418,13 @@ "description": "Creates or updates an IpFilterRule for a Namespace.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/IPFilterRuleNameParameter" + "$ref": "#/parameters/ipFilterRuleNameParameter" }, { "name": "parameters", @@ -436,10 +436,10 @@ "description": "The Namespace IpFilterRule." }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -470,19 +470,19 @@ "description": "Deletes an IpFilterRule for a Namespace.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/IPFilterRuleNameParameter" + "$ref": "#/parameters/ipFilterRuleNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -513,19 +513,19 @@ "description": "Gets an IpFilterRule for a Namespace by rule name.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/IPFilterRuleNameParameter" + "$ref": "#/parameters/ipFilterRuleNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -558,16 +558,16 @@ "description": "Gets a list of VirtualNetwork rules for a Namespace.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -603,13 +603,13 @@ "description": "Creates or updates an VirtualNetworkRule for a Namespace.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + "$ref": "#/parameters/virtualNetworkRuleNameParameter" }, { "name": "parameters", @@ -621,10 +621,10 @@ "description": "The Namespace VirtualNetworkRule." }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -655,19 +655,19 @@ "description": "Deletes an VirtualNetworkRule for a Namespace.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + "$ref": "#/parameters/virtualNetworkRuleNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -698,19 +698,19 @@ "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + "$ref": "#/parameters/virtualNetworkRuleNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -729,30 +729,30 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkruleset/default": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkrulesets/default": { "put": { "tags": [ "Namespaces" ], "x-ms-examples": { "NameSpaceVirtualNetworkRuleSetCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetCreate.json" + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetCreate.json" } }, - "operationId": "Namespaces_CreateNetworkRuleSet", + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", "description": "Gets NetworkRuleSet for a Namespace.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" }, { "name": "parameters", @@ -785,23 +785,23 @@ ], "x-ms-examples": { "NameSpaceVirtualNetworkRuleSetget": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetGet.json" + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNetworkRuleSetGet.json" } }, "operationId": "Namespaces_GetNetworkRuleSet", "description": "Gets NetworkRuleSet for a Namespace.", "parameters": [ { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/resourceGroupNameParameter" }, { - "$ref": "#/parameters/NamespaceNameParameter" + "$ref": "#/parameters/namespaceNameParameter" }, { - "$ref": "#/parameters/ApiVersionParameter" + "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "$ref": "#/parameters/subscriptionIdParameter" } ], "responses": { @@ -917,7 +917,7 @@ "properties": { "sku": { "$ref": "#/definitions/SBSku", - "description": "Porperties of Sku" + "description": "Properties of SKU" }, "properties": { "x-ms-client-flatten": true, @@ -936,7 +936,7 @@ "properties": { "sku": { "$ref": "#/definitions/SBSku", - "description": "Porperties of Sku" + "description": "Properties of SKU" }, "properties": { "x-ms-client-flatten": true, @@ -1077,7 +1077,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { @@ -1266,21 +1266,21 @@ } }, "parameters": { - "SubscriptionIdParameter": { + "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": { + "apiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client API version." }, - "ResourceGroupNameParameter": { + "resourceGroupNameParameter": { "name": "resourceGroupName", "in": "path", "required": true, @@ -1290,7 +1290,7 @@ "x-ms-parameter-location": "method", "description": "Name of the Resource group within the Azure subscription." }, - "NamespaceNameParameter": { + "namespaceNameParameter": { "name": "namespaceName", "in": "path", "required": true, @@ -1300,7 +1300,7 @@ "x-ms-parameter-location": "method", "description": "The namespace name" }, - "SkuNameParameter": { + "skuNameParameter": { "name": "sku", "in": "path", "required": true, @@ -1310,7 +1310,7 @@ "x-ms-parameter-location": "method", "description": "The sku type." }, - "SkipParameter": { + "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", @@ -1320,7 +1320,7 @@ "maximum": 1000, "x-ms-parameter-location": "method" }, - "TopParameter": { + "topParameter": { "name": "$top", "description": "May be used to limit the number of results to the most recent N usageDetails.", "in": "query", @@ -1330,7 +1330,7 @@ "maximum": 1000, "x-ms-parameter-location": "method" }, - "IPFilterRuleNameParameter": { + "ipFilterRuleNameParameter": { "name": "ipFilterRuleName", "in": "path", "required": true, @@ -1339,7 +1339,7 @@ "x-ms-parameter-location": "method", "description": "The IP Filter Rule name." }, - "VirtualNetworkRuleNameParameter": { + "virtualNetworkRuleNameParameter": { "name": "virtualNetworkRuleName", "in": "path", "required": true, diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2014-09-01/servicebus.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2014-09-01/servicebus.json index 43d755cc8e9f..22c7a34b9d38 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2014-09-01/servicebus.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2014-09-01/servicebus.json @@ -1139,7 +1139,7 @@ "Topics" ], "operationId": "Topics_CreateOrUpdateAuthorizationRule", - "description": "Creates an authorizatio rule for the specified topic.", + "description": "Creates an authorization rule for the specified topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" }, @@ -2319,7 +2319,7 @@ "description": "The exact time the message was updated." } }, - "description": "The Tpoic Properties definition." + "description": "The Topic Properties definition." }, "SubscriptionCreateOrUpdateParameters": { "properties": { @@ -2503,7 +2503,7 @@ "properties": { "name": { "type": "string", - "description": "The Name to check the namespce name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." } }, "required": [ @@ -2663,7 +2663,7 @@ "minLength": 1, "maxLength": 50, "x-ms-parameter-location": "method", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "queueNameParameter": { "name": "queueName", diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAutorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleDelete.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAutorizationRuleDelete.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleDelete.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAutorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleGet.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAutorizationRuleGet.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleGet.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAutorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleListAll.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAutorizationRuleListAll.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleListAll.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleRegenrateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleRegenrateKey.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBNameSpaceAuthorizationRuleRegenerateKey.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAutorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleDelete.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAutorizationRuleDelete.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleDelete.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAutorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleGet.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAutorizationRuleGet.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleGet.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAutorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleListAll.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAutorizationRuleListAll.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleListAll.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleRegenrateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleRegenrateKey.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBQueueAuthorizationRuleRegenerateKey.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAutorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleDelete.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAutorizationRuleDelete.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleDelete.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAutorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleGet.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAutorizationRuleGet.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleGet.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAutorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleListAll.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAutorizationRuleListAll.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleListAll.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleRegenrateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleRegenrateKey.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/examples/SBTopicAuthorizationRuleRegenerateKey.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/servicebus.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/servicebus.json index 5acd9a0e5ac5..f3174704e7b5 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/servicebus.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2015-08-01/servicebus.json @@ -361,7 +361,7 @@ ], "operationId": "Namespaces_ListAuthorizationRules", "x-ms-examples": { - "NameSpaceAutorizationRuleListAll": { "$ref": "./examples/SBNameSpaceAutorizationRuleListAll.json" } + "NameSpaceAuthorizationRuleListAll": { "$ref": "./examples/SBNameSpaceAuthorizationRuleListAll.json" } }, "description": "Gets the authorization rules for a namespace.", "externalDocs": { @@ -448,7 +448,7 @@ ], "operationId": "Namespaces_DeleteAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleDelete": { "$ref": "./examples/SBNameSpaceAutorizationRuleDelete.json" } + "NameSpaceAuthorizationRuleDelete": { "$ref": "./examples/SBNameSpaceAuthorizationRuleDelete.json" } }, "description": "Deletes a namespace authorization rule.", "externalDocs": { @@ -486,7 +486,7 @@ ], "operationId": "Namespaces_GetAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleGet": { "$ref": "./examples/SBNameSpaceAutorizationRuleGet.json" } + "NameSpaceAuthorizationRuleGet": { "$ref": "./examples/SBNameSpaceAuthorizationRuleGet.json" } }, "description": "Gets an authorization rule for a namespace by rule name.", "externalDocs": { @@ -566,7 +566,7 @@ ], "operationId": "Namespaces_RegenerateKeys", "x-ms-examples": { - "NameSpaceAuthorizationRuleRegenrateKey": { "$ref": "./examples/SBNameSpaceAuthorizationRuleRegenrateKey.json" } + "NameSpaceAuthorizationRuleRegenerateKey": { "$ref": "./examples/SBNameSpaceAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates the primary or secondary connection strings for the namespace.", "externalDocs": { @@ -780,7 +780,7 @@ ], "operationId": "Queues_ListAuthorizationRules", "x-ms-examples": { - "QueueAutorizationRuleListAll": { "$ref": "./examples/SBQueueAutorizationRuleListAll.json" } + "QueueAuthorizationRuleListAll": { "$ref": "./examples/SBQueueAuthorizationRuleListAll.json" } }, "description": "Gets all authorization rules for a queue.", "externalDocs": { @@ -870,7 +870,7 @@ ], "operationId": "Queues_PostAuthorizationRule", "x-ms-examples": { - "QueueAutorizationRuleGet": { "$ref": "./examples/SBQueueAutorizationRuleGet.json" } + "QueueAuthorizationRuleGet": { "$ref": "./examples/SBQueueAuthorizationRuleGet.json" } }, "description": "Gets an authorization rule for a queue by rule name.", "externalDocs": { @@ -911,7 +911,7 @@ ], "operationId": "Queues_DeleteAuthorizationRule", "x-ms-examples": { - "QueueAutorizationRuleDelete": { "$ref": "./examples/SBQueueAutorizationRuleDelete.json" } + "QueueAuthorizationRuleDelete": { "$ref": "./examples/SBQueueAuthorizationRuleDelete.json" } }, "description": "Deletes a queue authorization rule.", "externalDocs": { @@ -952,7 +952,7 @@ ], "operationId": "Queues_GetAuthorizationRule", "x-ms-examples": { - "QueueAutorizationRuleGet": { "$ref": "./examples/SBQueueAutorizationRuleGet.json" } + "QueueAuthorizationRuleGet": { "$ref": "./examples/SBQueueAuthorizationRuleGet.json" } }, "description": "Gets an authorization rule for a queue by rule name.", "externalDocs": { @@ -1038,7 +1038,7 @@ ], "operationId": "Queues_RegenerateKeys", "x-ms-examples": { - "QueueAuthorizationRuleRegenrateKey": { "$ref": "./examples/SBQueueAuthorizationRuleRegenrateKey.json" } + "QueueAuthorizationRuleRegenerateKey": { "$ref": "./examples/SBQueueAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates the primary or secondary connection strings to the queue.", "externalDocs": { @@ -1255,7 +1255,7 @@ ], "operationId": "Topics_ListAuthorizationRules", "x-ms-examples": { - "TopicAutorizationRuleListAll": { "$ref": "./examples/SBTopicAutorizationRuleListAll.json" } + "TopicAuthorizationRuleListAll": { "$ref": "./examples/SBTopicAuthorizationRuleListAll.json" } }, "description": "Gets authorization rules for a topic.", "externalDocs": { @@ -1300,7 +1300,7 @@ "x-ms-examples": { "TopicAuthorizationRuleCreate": { "$ref": "./examples/SBTopicAuthorizationRuleCreate.json" } }, - "description": "Creates an authorizatio rule for the specified topic.", + "description": "Creates an authorization rule for the specified topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" }, @@ -1348,7 +1348,7 @@ ], "operationId": "Topics_PostAuthorizationRule", "x-ms-examples": { - "TopicAutorizationRuleGet": { "$ref": "./examples/SBTopicAutorizationRuleGet.json" } + "TopicAuthorizationRuleGet": { "$ref": "./examples/SBTopicAuthorizationRuleGet.json" } }, "description": "Returns the specified authorization rule.", "externalDocs": { @@ -1389,7 +1389,7 @@ ], "operationId": "Topics_GetAuthorizationRule", "x-ms-examples": { - "TopicAutorizationRuleGet": { "$ref": "./examples/SBTopicAutorizationRuleGet.json" } + "TopicAuthorizationRuleGet": { "$ref": "./examples/SBTopicAuthorizationRuleGet.json" } }, "description": "Returns the specified authorization rule.", "externalDocs": { @@ -1430,7 +1430,7 @@ ], "operationId": "Topics_DeleteAuthorizationRule", "x-ms-examples": { - "TopicAutorizationRuleDelete": { "$ref": "./examples/SBTopicAutorizationRuleDelete.json" } + "TopicAuthorizationRuleDelete": { "$ref": "./examples/SBTopicAuthorizationRuleDelete.json" } }, "description": "Deletes a topic authorization rule.", "externalDocs": { @@ -1516,7 +1516,7 @@ ], "operationId": "Topics_RegenerateKeys", "x-ms-examples": { - "TopicAuthorizationRuleRegenrateKey": { "$ref": "./examples/SBTopicAuthorizationRuleRegenrateKey.json" } + "TopicAuthorizationRuleRegenerateKey": { "$ref": "./examples/SBTopicAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates primary or secondary connection strings for the topic.", "externalDocs": { @@ -2410,7 +2410,7 @@ "description": "The exact time the message was updated." } }, - "description": "The Tpoic Properties definition." + "description": "The Topic Properties definition." }, "SubscriptionCreateOrUpdateParameters": { "properties": { @@ -2594,7 +2594,7 @@ "properties": { "name": { "type": "string", - "description": "The Name to check the namespce name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." } }, "required": [ @@ -2713,7 +2713,7 @@ "minLength": 1, "maxLength": 50, "x-ms-parameter-location": "method", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "queueNameParameter": { "name": "queueName", diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAutorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAutorizationRuleDelete.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAutorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAutorizationRuleGet.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAutorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAutorizationRuleListAll.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenrateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenrateKey.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAutorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleDelete.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAutorizationRuleDelete.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleDelete.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAutorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleGet.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAutorizationRuleGet.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleGet.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAutorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleListAll.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAutorizationRuleListAll.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleListAll.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleRegenrateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleRegenrateKey.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Rules/RuleCreate_Corelationfilter.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Rules/RuleCreate_CorrelationFilter.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Rules/RuleCreate_Corelationfilter.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Rules/RuleCreate_CorrelationFilter.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Rules/RuleCreate_sqlfilter.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Rules/RuleCreate_SqlFilter.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Rules/RuleCreate_sqlfilter.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Rules/RuleCreate_SqlFilter.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAutorizationRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleDelete.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAutorizationRuleDelete.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleDelete.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAutorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleGet.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAutorizationRuleGet.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleGet.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAutorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleListAll.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAutorizationRuleListAll.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleListAll.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleRegenrateKey.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleRegenrateKey.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasAutorizationRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasAutorizationRuleGet.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasAutorizationRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json similarity index 100% rename from specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasAutorizationRuleListAll.json rename to specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json 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 86fae14e5cf3..ef9433dff693 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 @@ -409,7 +409,7 @@ ], "operationId": "Namespaces_ListAuthorizationRules", "x-ms-examples": { - "NameSpaceAutorizationRuleListAll": { "$ref": "./examples/NameSpaces/SBNameSpaceAutorizationRuleListAll.json" } + "NameSpaceAuthorizationRuleListAll": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleListAll.json" } }, "description": "Gets the authorization rules for a namespace.", "externalDocs": { @@ -508,7 +508,7 @@ ], "operationId": "Namespaces_DeleteAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleDelete": { "$ref": "./examples/NameSpaces/SBNameSpaceAutorizationRuleDelete.json" } + "NameSpaceAuthorizationRuleDelete": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleDelete.json" } }, "description": "Deletes a namespace authorization rule.", "externalDocs": { @@ -552,7 +552,7 @@ ], "operationId": "Namespaces_GetAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleGet": { "$ref": "./examples/NameSpaces/SBNameSpaceAutorizationRuleGet.json" } + "NameSpaceAuthorizationRuleGet": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleGet.json" } }, "description": "Gets an authorization rule for a namespace by rule name.", "externalDocs": { @@ -644,7 +644,7 @@ ], "operationId": "Namespaces_RegenerateKeys", "x-ms-examples": { - "NameSpaceAuthorizationRuleRegenrateKey": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenrateKey.json" } + "NameSpaceAuthorizationRuleRegenerateKey": { "$ref": "./examples/NameSpaces/SBNameSpaceAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates the primary or secondary connection strings for the namespace.", "externalDocs": { @@ -727,7 +727,7 @@ ], "responses": { "200": { - "description": "Migrate Namepsace type is successful." + "description": "Migrate Namespace type is successful." }, "default": { "description": "ServiceBus error response describing why the operation failed.", @@ -1013,7 +1013,7 @@ "x-ms-examples": { "SBAliasFailOver": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasFailOver.json" } }, - "description": "envokes GEO DR failover and reconfigure the alias to point to the secondary namespace", + "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -1051,7 +1051,7 @@ ], "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", "x-ms-examples": { - "NameSpaceAutorizationRuleListAll": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasAutorizationRuleListAll.json" } + "NameSpaceAuthorizationRuleListAll": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleListAll.json" } }, "description": "Gets the authorization rules for a namespace.", "externalDocs": { @@ -1100,7 +1100,7 @@ ], "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", "x-ms-examples": { - "DisasterRecoveryConfigsAutorizationRuleGet": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasAutorizationRuleGet.json" } + "DisasterRecoveryConfigsAuthorizationRuleGet": { "$ref": "./examples/disasterRecoveryConfigs/SBAliasAuthorizationRuleGet.json" } }, "description": "Gets an authorization rule for a namespace by rule name.", "externalDocs": { @@ -1243,7 +1243,7 @@ "x-ms-examples": { "MigrationConfigurationsStartMigration": { "$ref": "./examples/Migrationconfigurations/SBMigrationconfigurationCreateAndStartMigration.json" } }, - "description": "Creates Migration configuration and starts migration of enties from Standard to Premium namespace", + "description": "Creates Migration configuration and starts migration of entities from Standard to Premium namespace", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -1381,7 +1381,7 @@ "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.", + "description": "This operation Completes Migration of entities by pointing the connection strings to Premium namespace and any entities created after the operation will be under Premium Namespace. CompleteMigration operation will fail when entity migration is in-progress.", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -1654,7 +1654,7 @@ ], "operationId": "Queues_ListAuthorizationRules", "x-ms-examples": { - "QueueAutorizationRuleListAll": { "$ref": "./examples/Queues/SBQueueAutorizationRuleListAll.json" } + "QueueAuthorizationRuleListAll": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleListAll.json" } }, "description": "Gets all authorization rules for a queue.", "externalDocs": { @@ -1756,7 +1756,7 @@ ], "operationId": "Queues_DeleteAuthorizationRule", "x-ms-examples": { - "QueueAutorizationRuleDelete": { "$ref": "./examples/Queues/SBQueueAutorizationRuleDelete.json" } + "QueueAuthorizationRuleDelete": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleDelete.json" } }, "description": "Deletes a queue authorization rule.", "externalDocs": { @@ -1803,7 +1803,7 @@ ], "operationId": "Queues_GetAuthorizationRule", "x-ms-examples": { - "QueueAutorizationRuleGet": { "$ref": "./examples/Queues/SBQueueAutorizationRuleGet.json" } + "QueueAuthorizationRuleGet": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleGet.json" } }, "description": "Gets an authorization rule for a queue by rule name.", "externalDocs": { @@ -1901,7 +1901,7 @@ ], "operationId": "Queues_RegenerateKeys", "x-ms-examples": { - "QueueAuthorizationRuleRegenrateKey": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleRegenrateKey.json" } + "QueueAuthorizationRuleRegenerateKey": { "$ref": "./examples/Queues/SBQueueAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates the primary or secondary connection strings to the queue.", "externalDocs": { @@ -2154,7 +2154,7 @@ ], "operationId": "Topics_ListAuthorizationRules", "x-ms-examples": { - "TopicAutorizationRuleListAll": { "$ref": "./examples/Topics/SBTopicAutorizationRuleListAll.json" } + "TopicAuthorizationRuleListAll": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleListAll.json" } }, "description": "Gets authorization rules for a topic.", "externalDocs": { @@ -2205,7 +2205,7 @@ "x-ms-examples": { "TopicAuthorizationRuleCreate": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleCreate.json" } }, - "description": "Creates an authorizatio rule for the specified topic.", + "description": "Creates an authorization rule for the specified topic.", "externalDocs": { "url": "https://msdn.microsoft.com/en-us/library/azure/mt720678.aspx" }, @@ -2259,7 +2259,7 @@ ], "operationId": "Topics_GetAuthorizationRule", "x-ms-examples": { - "TopicAutorizationRuleGet": { "$ref": "./examples/Topics/SBTopicAutorizationRuleGet.json" } + "TopicAuthorizationRuleGet": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleGet.json" } }, "description": "Returns the specified authorization rule.", "externalDocs": { @@ -2306,7 +2306,7 @@ ], "operationId": "Topics_DeleteAuthorizationRule", "x-ms-examples": { - "TopicAutorizationRuleDelete": { "$ref": "./examples/Topics/SBTopicAutorizationRuleDelete.json" } + "TopicAuthorizationRuleDelete": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleDelete.json" } }, "description": "Deletes a topic authorization rule.", "externalDocs": { @@ -2404,7 +2404,7 @@ ], "operationId": "Topics_RegenerateKeys", "x-ms-examples": { - "TopicAuthorizationRuleRegenrateKey": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleRegenrateKey.json" } + "TopicAuthorizationRuleRegenerateKey": { "$ref": "./examples/Topics/SBTopicAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates primary or secondary connection strings for the topic.", "externalDocs": { @@ -2725,8 +2725,8 @@ "operationId": "Rules_CreateOrUpdate", "x-ms-examples": { "RulesCreateOrUpdate": { "$ref": "./examples/Rules/RuleCreate.json" }, - "RulesCreateSQLFilter": { "$ref": "./examples/Rules/RuleCreate_sqlfilter.json" }, - "RulesCreateCorelationFilter": { "$ref": "./examples/Rules/RuleCreate_Corelationfilter.json" } + "RulesCreateSqlFilter": { "$ref": "./examples/Rules/RuleCreate_SqlFilter.json" }, + "RulesCreateCorrelationFilter": { "$ref": "./examples/Rules/RuleCreate_CorrelationFilter.json" } }, "description": "Creates a new rule and updates an existing rule", "parameters": [ @@ -3091,7 +3091,7 @@ "properties": { "sku": { "$ref": "#/definitions/SBSku", - "description": "Porperties of Sku" + "description": "Properties of Sku" }, "properties": { "x-ms-client-flatten": true, @@ -3110,7 +3110,7 @@ "properties": { "sku": { "$ref": "#/definitions/SBSku", - "description": "Porperties of Sku" + "description": "Properties of Sku" }, "properties": { "x-ms-client-flatten": true, @@ -3358,7 +3358,7 @@ "required": [ "keyType" ], - "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key neeeds to be reset." + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." }, "SBQueueListResult": { "properties": { @@ -3599,7 +3599,7 @@ "countDetails": { "readOnly": true, "$ref": "#/definitions/MessageCountDetails", - "description": "Message count deatils" + "description": "Message count details" }, "defaultMessageTimeToLive": { "format": "duration", @@ -3646,7 +3646,7 @@ "description": "Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage." } }, - "description": "The Tpoic Properties definition." + "description": "The Topic Properties definition." }, "SBSubscriptionListResult": { "properties": { @@ -3805,7 +3805,7 @@ "properties": { "name": { "type": "string", - "description": "The Name to check the namespce name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." + "description": "The Name to check the namespace name availability and The namespace name can contain only letters, numbers, and hyphens. The namespace must start with a letter, and it must end with a letter or number." } }, "required": [ @@ -3881,7 +3881,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { @@ -4268,7 +4268,7 @@ "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" } }, - "description": "Properties describing the storage account, blob container and acrchive name format for capture destination" + "description": "Properties describing the storage account, blob container and archive name format for capture destination" } }, "description": "Capture storage details for capture description" @@ -4300,11 +4300,11 @@ }, "partnerNamespace": { "type": "string", - "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairning" + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" }, "alternateName": { "type": "string", - "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairning" + "description": "Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" }, "role": { "readOnly": true, @@ -4453,7 +4453,7 @@ "minLength": 1, "maxLength": 50, "x-ms-parameter-location": "method", - "description": "The authorizationrule name." + "description": "The authorization rule name." }, "QueueNameParameter": { "name": "queueName", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json index 8d561e0a5abe..b72de6f85cd4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json @@ -23,7 +23,9 @@ "storageSizeInGB": 1024, "licenseType": "Full", "collation": "SQL_Latin1_General_CP1_CI_AS", - "dnsZonePartner": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance" + "dnsZonePartner": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance", + "publicDataEndpointEnabled" : false, + "proxyOverride" : "Redirect" } } }, @@ -48,7 +50,9 @@ "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", "state": "Ready", "collation": "SQL_Latin1_General_CP1_CI_AS", - "dnsZone": "1b4e2caff2530" + "dnsZone": "1b4e2caff2530", + "publicDataEndpointEnabled" : false, + "proxyOverride" : "Redirect" } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json index 22733a1a4b59..7a178a87bd29 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceGet.json @@ -22,8 +22,9 @@ "storageSizeInGB": 1024, "licenseType": "Full", "collation": "SQL_Latin1_General_CP1_CI_AS", - "dnsZone": "1b4e2caff2530" - + "dnsZone": "1b4e2caff2530", + "publicDataEndpointEnabled" : false, + "proxyOverride" : "Default" }, "location" : "onebox", "id" : "/subscriptions/20d7082a-0fc7-4468-82bd-542694d5042b/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl", @@ -32,4 +33,4 @@ } } } -} \ 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 index 66da6d81b42e..9f0dc18cae6c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceList.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceList.json @@ -24,7 +24,9 @@ "storageSizeInGB": 1024, "licenseType": "Full", "collation": "SQL_Latin1_General_CP1_CI_AS", - "dnsZone": "1b4e2caff2530" + "dnsZone": "1b4e2caff2530", + "publicDataEndpointEnabled" : false, + "proxyOverride" : "Proxy" } }, { "location" : "onebox", @@ -44,11 +46,13 @@ "storageSizeInGB": 1024, "licenseType": "Full", "collation": "SQL_Latin1_General_CP1_CI_AS", - "dnsZone": "1b4e2caff2530" + "dnsZone": "1b4e2caff2530", + "publicDataEndpointEnabled" : false, + "proxyOverride" : "" } } ] } } } -} \ 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 index 18f9e0dfebda..336a77eebe1b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceListByResourceGroup.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceListByResourceGroup.json @@ -26,7 +26,9 @@ "storageSizeInGB": 1024, "licenseType": "Full", "collation": "SQL_Latin1_General_CP1_CI_AS", - "dnsZone": "1b4e2caff2530" + "dnsZone": "1b4e2caff2530", + "publicDataEndpointEnabled" : false, + "proxyOverride" : "Redirect" } }, { "location" : "onebox", @@ -47,11 +49,13 @@ "storageSizeInGB": 1024, "licenseType": "Full", "collation": "SQL_Latin1_General_CP1_CI_AS", - "dnsZone": "1b4e2caff2530" + "dnsZone": "1b4e2caff2530", + "publicDataEndpointEnabled" : false, + "proxyOverride" : "" } } ] } } } -} \ 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 index 2ef9cedcd499..2ba88d0030f9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceUpdateMax.json @@ -17,7 +17,9 @@ "fullyQualifiedDomainName" : "testinstance.1b4e2caff2530.database.windows.net", "administratorLogin" : "dummylogin", "administratorLoginPassword" : "Un53cuRE!", - "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "proxyOverride": "Redirect", + "publicDataEndpointEnabled": false } } }, @@ -42,7 +44,9 @@ "subnetId" : "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", "state": "Ready", "collation": "SQL_Latin1_General_CP1_CI_AS", - "dnsZone": "1b4e2caff2530" + "dnsZone": "1b4e2caff2530", + "proxyOverride": "Redirect", + "publicDataEndpointEnabled": false } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json index 6af4102fcf51..e2bc6b9668e5 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json @@ -371,6 +371,19 @@ "x-ms-mutability": [ "create" ] + }, + "publicDataEndpointEnabled": { + "description": "Whether or not the public data endpoint is enabled.", + "type": "boolean" + }, + "proxyOverride": { + "description": "Connection type used for connecting to the instance.", + "enum": ["Proxy", "Redirect", "Default"], + "x-ms-enum":{ + "name": "ManagedInstanceProxyOverride", + "modelAsString": true + }, + "type": "string" } } }, @@ -524,4 +537,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivityLabelCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivityLabelCreateMax.json index fe6131a05b41..c0505003f4ba 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivityLabelCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivityLabelCreateMax.json @@ -1,43 +1,49 @@ { + "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": { - "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" - } + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.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": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" } + } }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.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" - } - } + "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": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" } + } } + } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivityLabelGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivityLabelGet.json index e3e5f81b1493..c887c51473ac 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivityLabelGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ColumnSensitivityLabelGet.json @@ -1,26 +1,28 @@ { - "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" - } - } + "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": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" } + } } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyCreateOrUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyCreateOrUpdate.json index dea59f79b96b..0122980b97b3 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyCreateOrUpdate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/LongTermRetentionPolicyCreateOrUpdate.json @@ -1,4 +1,4 @@ -{ +{ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "resourceGroup", @@ -6,11 +6,13 @@ "databaseName": "testDatabase", "policyName" : "default", "api-version": "2017-03-01", - "parameters" : { - "weeklyRetention": "P1M", - "monthlyRetention": "P1Y", - "yearlyRetention": "P5Y", - "weekOfYear": 5 + "parameters": { + "properties" : { + "weeklyRetention": "P1M", + "monthlyRetention": "P1Y", + "yearlyRetention": "P5Y", + "weekOfYear": 5 + } } }, "responses": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRecovery.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRecovery.json new file mode 100644 index 000000000000..58c99c26f59a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseCreateRecovery.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "server1", + "databaseName": "testdb_recovered", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "properties": { + "createMode": "Recovery", + "RecoverableDatabaseId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/Default-SQL-WestEurope/providers/Microsoft.Sql/managedInstances/testsvr/recoverableDatabases/testdb" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/server1/recoverableDatabases/testdb_recovered", + "name": "testdb_recovered", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2018-11-07T04:41:33.937Z" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/recoverableDatabases/testdb_recovered", + "name": "testdb_recovered", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2018-11-07T04:41:33.937Z" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "202": { } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabase.json deleted file mode 100644 index 33441c2f00c6..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabase.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "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/SensitivityLabelsListByDatabaseWithSourceCurrent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json index 881d34e61413..bcfc14c94d9b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json @@ -1,35 +1,39 @@ { - "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/myColumn3/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/myColumn4/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "Email" - } - } - ] + "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/myColumn3/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Financial", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a", + "labelName": "Sensitive" } - } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn4/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Email", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + ] + } } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json index ae75f6dd979e..ffdde26ff8e9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json @@ -1,35 +1,39 @@ { - "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/recommended", - "name": "recommended", - "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" - } - } - ] + "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/recommended", + "name": "recommended", + "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Financial", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a", + "labelName": "Sensitive" } - } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.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": { + "informationType": "Email", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + ] + } } + } } \ No newline at end of file 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 2f7d2d121246..561f3606487d 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 @@ -34,12 +34,14 @@ { "name": "longTermRetentionServerName", "in": "path", + "description": "The name of the server", "required": true, "type": "string" }, { "name": "longTermRetentionDatabaseName", "in": "path", + "description": "The name of the database", "required": true, "type": "string" }, @@ -91,12 +93,14 @@ { "name": "longTermRetentionServerName", "in": "path", + "description": "The name of the server", "required": true, "type": "string" }, { "name": "longTermRetentionDatabaseName", "in": "path", + "description": "The name of the database", "required": true, "type": "string" }, @@ -151,12 +155,14 @@ { "name": "longTermRetentionServerName", "in": "path", + "description": "The name of the server", "required": true, "type": "string" }, { "name": "longTermRetentionDatabaseName", "in": "path", + "description": "The name of the database", "required": true, "type": "string" }, @@ -269,6 +275,7 @@ { "name": "longTermRetentionServerName", "in": "path", + "description": "The name of the server", "required": true, "type": "string" }, 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 index 61fb8763d07b..a070a1786305 100644 --- 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 @@ -87,58 +87,11 @@ "$ref": "#/parameters/DatabaseNameParameter" }, { - "name": "$filter", + "name": "$skipToken", "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 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." - } - }, - "x-ms-odata": "#/definitions/SensitivityLabel", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets the recommended sensitivity labels of a given database": { - "$ref": "./examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json" - } - } - } - }, - "/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", @@ -169,8 +122,8 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Gets the current and recommended sensitivity labels of a given database": { - "$ref": "./examples/SensitivityLabelsListByDatabase.json" + "Gets the recommended sensitivity labels of a given database": { + "$ref": "./examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json" } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetRecoverableManagedDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetRecoverableManagedDatabase.json new file mode 100644 index 000000000000..8e4906b09671 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/GetRecoverableManagedDatabase.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Test1", + "managedInstanceName": "managedInstance", + "recoverableDatabaseName": "testdb", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "lastAvailableBackupDate": "2017-05-26T01:06:29.78Z" + }, + "id": + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/recoverableDatabases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/managedInstances/recoverableDatabases" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListRecoverableManagedDatabasesByServer.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListRecoverableManagedDatabasesByServer.json new file mode 100644 index 000000000000..f07adaf412c1 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ListRecoverableManagedDatabasesByServer.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Test1", + "managedInstanceName": "managedInstance", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "lastAvailableBackupDate": "2017-05-26T01:06:29.78Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/recoverableDaatabases/testdb", + "name": "testdb", + "type": "Microsoft.Sql/managedInstances/recoverableDaatabases" + }, + { + "properties": { + "lastAvailableBackupDate": "2018-04-26T02:17:23.44Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/recoverableDaatabases/testdb2", + "name": "testdb2", + "type": "Microsoft.Sql/managedInstances/recoverableDaatabases" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json new file mode 100644 index 000000000000..73a2e0c1f616 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json @@ -0,0 +1,283 @@ +{ + "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}/recoverableDatabases": { + "get": { + "tags": [ + "RecoverableManagedDatabases" + ], + "description": "Gets a list of recoverable managed databases.", + "operationId": "RecoverableManagedDatabases_ListByInstance", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of recoverable managed databases.", + "schema": { + "$ref": "#/definitions/RecoverableManagedDatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List recoverable databases by managed instances": { + "$ref": "./examples/ListRecoverableManagedDatabasesByServer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/recoverableDatabases/{recoverableDatabaseName}": { + "get": { + "tags": [ + "RecoverableManagedDatabases" + ], + "description": "Gets a recoverable managed database.", + "operationId": "RecoverableManagedDatabases_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "recoverableDatabaseName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified recoverable managed database.", + "schema": { + "$ref": "#/definitions/RecoverableManagedDatabase" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Gets a recoverable databases by managed instances": { + "$ref": "./examples/GetRecoverableManagedDatabase.json" + } + } + } + } + }, + "definitions": { + "RecoverableManagedDatabaseListResult": { + "description": "A list of recoverable managed databases.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoverableManagedDatabase" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "RecoverableManagedDatabaseProperties": { + "description": "The recoverable managed database's properties.", + "type": "object", + "properties": { + "lastAvailableBackupDate": { + "description": "The last available backup date.", + "type": "string", + "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 + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "RecoverableManagedDatabase": { + "description": "A recoverable managed database resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoverableManagedDatabaseProperties", + "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/2018-06-01-preview/examples/ManagedDatabaseColumnSensitivityLabelCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseColumnSensitivityLabelCreate.json index 42e41a45f96a..09b08ac16172 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseColumnSensitivityLabelCreate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseColumnSensitivityLabelCreate.json @@ -1,43 +1,49 @@ { + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "managedInstanceName": "myManagedInstanceName", + "databaseName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "current", + "api-version": "2018-06-01-preview", "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "managedInstanceName": "myManagedInstanceName", - "databaseName": "myDatabase", - "schemaName": "dbo", - "tableName": "myTable", - "columnName": "myColumn", - "sensitivityLabelSource": "current", - "api-version": "2018-06-01-preview", - "parameters": { - "properties": { - "labelName": "PII", - "informationType": "PhoneNumber" - } + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" } + } }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "PhoneNumber" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "PhoneNumber" - } - } + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" } + } } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseColumnSensitivityLabelGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseColumnSensitivityLabelGet.json index a35daec7326f..d0c83b702eb9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseColumnSensitivityLabelGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseColumnSensitivityLabelGet.json @@ -1,26 +1,28 @@ { - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "managedInstanceName": "myManagedInstanceName", - "databaseName": "myDatabase", - "schemaName": "dbo", - "tableName": "myTable", - "columnName": "myColumn", - "sensitivityLabelSource": "current", - "api-version": "2018-06-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "PhoneNumber" - } - } + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "managedInstanceName": "myManagedInstanceName", + "databaseName": "myDatabase", + "schemaName": "dbo", + "tableName": "myTable", + "columnName": "myColumn", + "sensitivityLabelSource": "current", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "PhoneNumber", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" } + } } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabase.json deleted file mode 100644 index d888678cfcb2..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabase.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "managedInstanceName": "myManagedInstanceName", - "databaseName": "myDatabase", - "api-version": "2018-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "Sensitive", - "informationType": "Financial" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended", - "name": "recommended", - "type": "Microsoft.Sql/managedInstances/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/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabaseCurrent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabaseCurrent.json index 9874e5550a84..1b203ff437ab 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabaseCurrent.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabaseCurrent.json @@ -1,36 +1,40 @@ { - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "managedInstanceName": "myManagedInstanceName", - "databaseName": "myDatabase", - "sensitivityLabelSource": "current", - "api-version": "2018-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "Sensitive", - "informationType": "Financial" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn3/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "Email" - } - } - ] + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "managedInstanceName": "myManagedInstanceName", + "databaseName": "myDatabase", + "sensitivityLabelSource": "current", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Financial", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a", + "labelName": "Sensitive" } - } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn3/sensitivityLabels/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Email", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + ] + } } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabaseRecommended.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabaseRecommended.json index 33713346e38d..09aca312887d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabaseRecommended.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseSensitivityLabelsListByDatabaseRecommended.json @@ -1,36 +1,40 @@ { - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "managedInstanceName": "myManagedInstanceName", - "databaseName": "myDatabase", - "sensitivityLabelSource": "recommended", - "api-version": "2018-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended", - "name": "recommended", - "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "Sensitive", - "informationType": "Financial" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn4/sensitivityLabels/recommended", - "name": "recommended", - "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "Email" - } - } - ] + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "managedInstanceName": "myManagedInstanceName", + "databaseName": "myDatabase", + "sensitivityLabelSource": "recommended", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended", + "name": "recommended", + "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Financial", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a", + "labelName": "Sensitive" } - } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn4/sensitivityLabels/recommended", + "name": "recommended", + "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels", + "properties": { + "informationType": "Email", + "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646", + "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff", + "labelName": "PII" + } + } + ] + } } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json index 9ca6c46329f5..b3061d4f4c6d 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json @@ -168,7 +168,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 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" + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 400 LabelIdMustBeGuid - Label ID must be a GUID\n\n * 400 InformationTypeIdMustBeGuid - Information type ID must be a GUID\n\n * 400 LabelMissing - Label is missing\n\n * 400 InformationTypeMissing - Information Type is missing\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" }, "201": { "description": "Successfully created the sensitivity label.", @@ -256,59 +256,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/sensitivityLabels": { - "get": { - "tags": [ - "ManagedDatabaseSensitivityLabels" - ], - "description": "Gets the sensitivity labels of a given database", - "operationId": "ManagedDatabaseSensitivityLabels_ListByDatabase", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "$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 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." - } - }, - "x-ms-odata": "#/definitions/SensitivityLabel", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets the current and recommended sensitivity labels of a given database": { - "$ref": "./examples/ManagedDatabaseSensitivityLabelsListByDatabase.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/currentSensitivityLabels": { "get": { "tags": [ @@ -379,6 +326,12 @@ { "$ref": "#/parameters/DatabaseNameParameter" }, + { + "name": "$skipToken", + "in": "query", + "required": false, + "type": "string" + }, { "name": "$filter", "in": "query", @@ -425,9 +378,17 @@ "description": "The label name.", "type": "string" }, + "labelId": { + "description": "The label ID.", + "type": "string" + }, "informationType": { "description": "The information type.", "type": "string" + }, + "informationTypeId": { + "description": "The information type ID.", + "type": "string" } } }, diff --git a/specification/sql/resource-manager/readme.java.md b/specification/sql/resource-manager/readme.java.md index c9f17e8980fd..dec84775a157 100644 --- a/specification/sql/resource-manager/readme.java.md +++ b/specification/sql/resource-manager/readme.java.md @@ -63,9 +63,12 @@ java: regenerate-manager: true generate-interface: true directive: - rename-model: - from: DataWarehouseUserActivities - to: DataWarehouseUserActivity + - rename-model: + from: DataWarehouseUserActivities + to: DataWarehouseUserActivity + - rename-operation: + from: SensitivityLabels_ListRecommendedByDatabase + to: RecommendedSensitivityLabels_ListByDatabase ``` ### Tag: package-pure-2017-10-preview and java diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index be0936c4f6a7..0b49e055c4d4 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -89,12 +89,15 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json +- Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - Microsoft.Sql/preview/2017-10-01-preview/capabilities.json @@ -110,8 +113,10 @@ input-file: - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json - Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json - Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json # Needed when there is more than one input file @@ -174,13 +179,16 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json - Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json +- Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json @@ -193,8 +201,10 @@ input-file: - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json - Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json - Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json # Needed when there is more than one input file override-info: @@ -250,13 +260,16 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/jobs.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json - Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json +- Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json @@ -269,8 +282,10 @@ input-file: - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json - Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json - Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json # Needed when there is more than one input file override-info: @@ -328,9 +343,11 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.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/restorableDroppedManagedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json # Needed when there is more than one input file @@ -461,6 +478,7 @@ input-file: - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json + - ./Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json # Needed when there is more than one input file override-info: @@ -489,13 +507,16 @@ input-file: - ./Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - ./Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json + - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json - ./Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json + - ./Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json - ./Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - ./Microsoft.Sql/preview/2017-03-01-preview/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/ManagedDatabaseSecurityAlertPolicies.json - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json + - ./Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json # Needed when there is more than one input file override-info: @@ -582,6 +603,14 @@ override-info: title: SqlManagementClient ``` +## Suppression +``` yaml +directive: + - suppress: TrackedResourcePatchOperation + from: restorableDroppedManagedDatabases.json + reason: dropped database shouldn’t support patch +``` + --- ## Code Generation diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json index e7321f635cf1..c9949537495c 100644 --- a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json @@ -330,7 +330,7 @@ "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "in": "header", "required": false, "type": "string" @@ -378,7 +378,7 @@ "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. 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" @@ -482,7 +482,7 @@ { "name": "upn", "in": "query", - "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false.", + "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", "required": false, "type": "boolean" } @@ -521,7 +521,7 @@ "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-namespace-enabled": { @@ -587,7 +587,7 @@ "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.", - "pattern": "^[a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", + "pattern": "^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", "minLength": 3, "maxLength": 63, "required": true, @@ -792,7 +792,7 @@ { "name": "x-ms-rename-source", "in": "header", - "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.", + "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "required": false, "type": "string" }, @@ -814,7 +814,7 @@ }, { "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "in": "header", "required": false, "type": "string" @@ -952,7 +952,7 @@ "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-request-id": { @@ -1021,6 +1021,13 @@ "required": false, "type": "boolean" }, + { + "name": "close", + "in": "query", + "description": "Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is \"flush\" and change notifications are enabled. If the value of close is \"true\" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If \"false\" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed.\"", + "required": false, + "type": "boolean" + }, { "name": "Content-Length", "in": "header", @@ -1075,7 +1082,7 @@ }, { "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. 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" @@ -1404,7 +1411,7 @@ "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-lease-duration": { @@ -1486,7 +1493,7 @@ "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-lease-duration": { @@ -1626,7 +1633,7 @@ "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.", + "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 a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-owner": { @@ -1682,7 +1689,7 @@ { "name": "upn", "in": "query", - "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false.", + "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", "required": false, "type": "boolean" }, @@ -1816,7 +1823,7 @@ "name": "filesystem", "in": "path", "description": "The filesystem identifier.", - "pattern": "^[a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", + "pattern": "^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", "minLength": 3, "maxLength": 63, "required": true, diff --git a/specification/storage/data-plane/readme.go.md b/specification/storage/data-plane/readme.go.md index 48e8e66aede0..7c5751255cb4 100644 --- a/specification/storage/data-plane/readme.go.md +++ b/specification/storage/data-plane/readme.go.md @@ -23,7 +23,7 @@ These settings apply only when `--tag=package-2018-11 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-11' && $(go) -output-folder: $(go-sdk-folder)/services/stable/storage/datalake/2018-11-09/$(namespace) +output-folder: $(go-sdk-folder)/services/storage/datalake/2018-11-09/$(namespace) ``` ### Tag: package-2018-06-preview and go @@ -33,4 +33,4 @@ Please also specify `--go-sdk-folder=true if this supports Application Insights; otherwise, false.", + "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 1b450e2db1b3..5a5a4b9c8a20 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 @@ -1632,7 +1632,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/virtualNetwork": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": { "get": { "tags": [ "WebApps" @@ -8723,7 +8723,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/virtualNetwork": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork": { "get": { "tags": [ "WebApps" @@ -20264,6 +20264,10 @@ "description": "The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", "type": "string" }, + "clientSecretCertificateThumbprint": { + "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional.", + "type": "string" + }, "issuer": { "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html", "type": "string" diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 000000000000..dbfdac46ba4a --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,60 @@ +{ + "compilerOptions": { + /* Basic Options */ + "target": "esnext", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + "declaration": true, /* Generates corresponding '.d.ts' file. */ + "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + "outDir": "./dist", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + "noUnusedLocals": true, /* Report errors on unused locals. */ + "noUnusedParameters": true, /* Report errors on unused parameters. */ + "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + } +} \ No newline at end of file