From 48046f27e2d1b735529eff4815d695e431d6e23b Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Wed, 23 Mar 2016 16:04:15 -0700 Subject: [PATCH 01/18] Porting Klein's initial changes to new fork --- .../swagger/webservices.json | 950 ++++++++++++++++++ .../swagger/webservices.json | 950 ++++++++++++++++++ 2 files changed, 1900 insertions(+) create mode 100644 arm-machinelearning/2016-04-01-preview/swagger/webservices.json create mode 100644 arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json diff --git a/arm-machinelearning/2016-04-01-preview/swagger/webservices.json b/arm-machinelearning/2016-04-01-preview/swagger/webservices.json new file mode 100644 index 000000000000..7722d8682626 --- /dev/null +++ b/arm-machinelearning/2016-04-01-preview/swagger/webservices.json @@ -0,0 +1,950 @@ +{ + "swagger": "2.0", + "host": "management.azure.com", + "info": { + "title": "Machine Learning Web Services Management Client APIs", + "description": "These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:", + "version": "2016-04-01-preview" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { + "put": { + "operationId": "CreateOrUpdateWebService", + "description": "Create a new Web Service or update an existing one.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/CreateOrUpdateWebServiceRequestPayloadSchema" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "get": { + "operationId": "GetWebService", + "description": "Retrieve a Web Service information by its name", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "patch": { + "operationId": "PatchWebService", + "description": "Patch an existing Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PatchWebServiceRequestPayloadSchema" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "delete": { + "operationId": "DeleteWebService", + "description": "Delete an existing Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No-Content. The Web Service is not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { + "get": { + "operationId": "GetWebServiceKeys", + "description": "Get the primary and secondary keys of a particular Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebServiceKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "operationId": "GetWebServicesInResourceGroup", + "description": "Retrieve all Web Services' information in a given Resource Group", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The list of Web Services", + "items": { + "$ref": "#/definitions/WebService" + } + }, + "nextLink": { + "type": "string", + "description": "[TODO] Next Link" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "operationId": "GetWebServicesInSubscription", + "description": "Get all Web Services' information in current Azure subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Web Services", + "items": { + "$ref": "#/definitions/WebService" + } + }, + "nextLink": { + "type": "string", + "description": "[TODO] Next Link" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft/MachineLearning/checkNameAvailability": { + "post": { + "operationId": "CheckNameAvaliability", + "description": "Check the Web Service Name is valid and not in use", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/CheckNameAvailabilitySchema" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + } + } + } + }, + "/providers/Microsoft.MachineLearning/operations": { + "get": { + "operationId": "GetOperations", + "description": "Get all available operations of a Web Service", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Operations", + "items": { + "$ref": "#/definitions/OperationSchema" + } + } + } + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "in": "path", + "type": "string", + "required": true + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "The name of the resource group within the user's subscription.", + "in": "path", + "type": "string", + "required": true + }, + "WebServiceNameParameter": { + "name": "webServiceName", + "description": "The Web Service name which you want to reach.", + "in": "path", + "type": "string", + "required": true + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "Client Api Version.", + "required": true, + "enum": [ "2016-02-01-preview" ] + }, + "CreateOrUpdateWebServiceRequestPayloadSchema": { + "in": "body", + "name": "createOrUpdatePayload", + "description": "The payload to create or update a Web Service", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } + }, + "PatchWebServiceRequestPayloadSchema": { + "in": "body", + "name": "patchPayload", + "description": "[TODO] Patch Web Service Request Payload. It indicates all fields could be pacthed.", + "required": true, + "schema": { + "type": "object", + "title": "patchPayload", + "properties": { + "tags": { + "$ref": "#/definitions/Tags" + }, + "properties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the Web Service" + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys" + }, + "realtimeConfiguration": { + "$ref": "#/definitions/RealtimeConfiguration" + }, + "diagnostics": { + "$ref": "#/definitions/Diagnostics" + } + } + }, + "sku": { + "type": "object", + "description": "[TODO] SKU", + "properties": { + "name": { + "type": "string", + "description": "[TODO] Name" + }, + "tier": { + "type": "string", + "description": "[TODO] Tier" + } + } + } + } + } + }, + "CheckNameAvailabilitySchema": { + "in": "body", + "name": "checkNameAvailabilityPayload", + "description": "The payload to check name availability", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Web Service Name" + }, + "type": { + "type": "string", + "description": "The Web Service Type" + } + } + } + } + }, + "definitions": { + "WebService": { + "type": "object", + "title": "[TODO] The Web Service Object", + "properties": { + "location": { + "type": "string", + "description": "The Azure region where the web service is deployed." + }, + "tags": { + "$ref": "#/definitions/Tags" + }, + "properties": { + "$ref": "#/definitions/WebServiceProperties" + } + } + }, + "WebServiceProperties": { + "type": "object", + "description": "The definition of the web service being deployed.", + "required": [ + "packageType" + ], + "discriminator": "packageType", + "properties": { + "description": { + "type": "string", + "description": "The description the Web Service" + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys" + }, + "operationModes": { + "type": "array", + "description": "[TODO] Operation Modes", + "items": { + "type": "string", + "description": "[TODO] Operation Mode" + } + }, + "realtimeConfiguration": { + "$ref": "#/definitions/RealtimeConfiguration" + }, + "batchConfiguration": { + "$ref": "#/definitions/BatchConfiguration" + }, + "readOnly": { + "type": "boolean", + "description": "True, if the Web Service should be read-only; False, otherwise" + }, + "diagnostics": { + "$ref": "#/definitions/Diagnostics" + }, + "storageAccount": { + "$ref": "#/definitions/StorageAccount" + }, + "machineLearningWorkspace": { + "$ref": "#/definitions/MachineLearningWorkspace" + }, + "input": { + "$ref": "#/definitions/ModuleInterface" + }, + "output": { + "$ref": "#/definitions/ModuleInterface" + }, + "assets": { + "$ref": "#/definitions/AssetProperties" + }, + "parameters": { + "type": "object", + "description": "[TODO] Parameters of module package", + "additionalProperties": { + "type": "string" + } + }, + "packageType": { + "type": "string", + "description": "[TODO] Module package type", + "enum": [ + "Code", + "Graph" + ] + } + } + }, + "WebServicePropertiesForGraph": { + "description": "[TODO] Payload for Graph package", + "x-ms-discriminator-value": "Graph", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Graph Package", + "properties": { + "nodes": { + "type": "object", + "description": "[TODO] Graph nodes collection", + "additionalProperties": { + "$ref": "#/definitions/GraphNode" + } + }, + "edges": { + "type": "array", + "description": "[TODO] List of Graph Edges", + "items": { + "$ref": "#/definitions/GraphEdge" + } + }, + "graphParameters": { + "type": "object", + "description": "[TODO] Graph parameter collection", + "additionalProperties": { + "$ref": "#/definitions/GraphParameter" + } + } + } + } + } + }, + "WebServicePropertiesForCode": { + "description": "[TODO] Payload for Code package", + "x-ms-discriminator-value": "Code", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Code Package", + "properties": { + "language": { + "type": "string", + "description": "[TODO] The language of source code", + "enum": [ + "Python-2.7", + "R-3.1" + ] + }, + "sourceCode": { + "type": "string", + "description": "[TODO] The source code" + }, + "zipFileAssetId": { + "type": "string", + "description": "[TODO] Zip file's Asset ID" + } + } + } + } + }, + "GraphNode": { + "type": "object", + "description": "[TODO] Graph Node", + "properties": { + "assetId": { + "type": "string", + "description": "[TODO] Asset ID" + }, + "inputId": { + "type": "string", + "description": "[TODO] Input ID" + }, + "outputId": { + "type": "string", + "description": "[TODO] Output ID" + }, + "parameters": { + "type": "object", + "description": "[TODO] Node Parameters", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GraphEdge": { + "type": "object", + "description": "[TODO] Graph edge", + "properties": { + "sourceNode": { + "type": "string", + "description": "[TODO] Edge source" + }, + "sourceOutputPort": { + "type": "string", + "description": "[TODO] Source node output port" + }, + "targetNode": { + "type": "string", + "description": "[TODO] Edge target" + }, + "targetInputPort": { + "type": "string", + "description": "[TODO] Target node input port" + } + } + }, + "GraphParameter": { + "type": "object", + "description": "[TODO] Graph Parameter", + "properties": { + "description": { + "type": "string", + "description": "[TODO] Description of this Graph parameter" + }, + "defaultValue": { + "type": "string", + "description": "[TODO] The default value of this parameter. Could be null" + }, + "links": { + "type": "array", + "description": "[TODO] Links of this parameter", + "items": { + "$ref": "#/definitions/GraphParameterLink" + } + } + } + }, + "GraphParameterLink": { + "type": "object", + "description": "[TODO] The link in Graph Paramter", + "properties": { + "nodeId": { + "type": "string", + "description": "[TODO] The node ID" + }, + "parameterId": { + "type": "string", + "description": "[TODO] The parameter ID" + } + } + }, + "OperationSchema": { + "type": "object", + "description": "[TODO] The Web Service Operation Description", + "properties": { + "name": { + "type": "string", + "description": "The operation name" + }, + "display": { + "type": "object", + "description": "[TODO] Display", + "properties": { + "provider": { + "type": "string", + "description": "[TODO] Provider", + "default": "Machine Learning" + }, + "resource": { + "type": "string", + "description": "[TODO] Resource", + "default": "Web Service" + }, + "operation": { + "type": "string", + "description": "[TODO] Operation" + }, + "description": { + "type": "string", + "description": "[TODO] Description" + } + } + }, + "origin": { + "type": "string", + "description": "[TODO] Origin", + "enum": [ + "user", + "system", + "user, system" + ] + } + } + }, + "Tags": { + "type": "object", + "description": "The tags associated with this web service.", + "properties": { + "Experiement Location": { + "type": "string", + "description": "[TODO] Experiement Run Location" + } + } + }, + "RealtimeConfiguration": { + "type": "object", + "description": "Configuration settings for RRS", + "properties": { + "maxConcurrentCalls": { + "type": "integer", + "description": "[TODO] Max Concurrent Calls" + }, + "maxMemoryInMB": { + "type": "integer", + "description": "[TODO] Max Memory in MB" + }, + "maxDurationInSeconds": { + "type": "integer", + "description": "[TODO] Max Duration in Seconds" + } + } + }, + "BatchConfiguration": { + "type": "object", + "description": "[TODO] Batch Configuration", + "properties": { + "JobDriver": { + "type": "string", + "description": "[TODO] version, optional, etc." + }, + "Cluster": { + "$ref": "#/definitions/ClusterDefinition" + } + } + }, + "ClusterDefinition": { + "type": "object", + "description": "[TODO] Properties of GraphSharp", + "properties": { + "id": { + "type": "string", + "description": "ARM HDI cluster ID" + } + } + }, + "Diagnostics": { + "type": "object", + "description": "The Diagnostics Settings", + "properties": { + "level": { + "type": "string", + "description": "Trace Level: None, Error, All" + }, + "expiry": { + "type": "string", + "description": "[TODO] Expiry" + } + } + }, + "StorageAccount": { + "type": "object", + "description": "[TODO] The Storage Account used in GraphSharp", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The Storage Account ID" + } + } + }, + "MachineLearningWorkspace": { + "type": "object", + "description": "[TODO] The Machine Learning Workspace", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The Workspace ID" + } + } + }, + "WebServiceKeys": { + "type": "object", + "description": "Web Service Keys", + "properties": { + "prmiary": { + "type": "string", + "description": "The Primary Key" + }, + "secondary": { + "type": "string", + "description": "The Secondary Key" + } + } + }, + "CheckNameResult": { + "type": "object", + "properties": { + "nameAvaliable": { + "type": "boolean", + "description": "True, if the name is available; False, otherwise" + }, + "reason": { + "type": "string", + "description": "The reason why if it is not available", + "enum": [ + "Invalid", + "AlreadyExists" + ] + }, + "message": { + "type": "string", + "description": ": The message from the server" + } + } + }, + "ModuleInterface": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Interface Title" + }, + "description": { + "type": "string", + "description": "[TODO] Description of the Interface" + }, + "type": { + "type": "string", + "description": "[TODO] Interface properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AfxDataTable" + } + } + } + }, + "AssetProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetItem" + } + }, + "AfxDataTable": { + "type": "object", + "description": "[TODO] Afx data table", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Table title" + }, + "description": { + "type": "string", + "description": "[TODO] Table description" + }, + "type": { + "type": "string", + "description": "[TODO] Table properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AfxDataTableColumn" + } + } + } + }, + "AfxDataTableColumn": { + "type": "object", + "description": "[TODO] Afx data table column", + "properties": { + "type": { + "type": "string", + "description": "[TODO] Data type" + }, + "format": { + "type": "string", + "description": "[TODO] Data format" + }, + "enum": { + "type": "array", + "description": "[TODO] Options", + "items": { + "$ref": "#/definitions/AfxDataTableColumnEnum" + } + }, + "x-ms-isnullable": { + "type": "boolean", + "description": "[TODO] Is nullable" + }, + "x-ms-isordered": { + "type": "boolean", + "description": "[TODO] Is enum in order" + } + } + }, + "AfxDataTableColumnEnum": { + "type": "string", + "description": "[TODO] Enum item" + }, + "AssetItem": { + "type": "object", + "description": "[TODO] Asset Name", + "properties": { + "name": { + "type": "string", + "description": "Module friendly name" + }, + "type": { + "type": "string", + "description": "Module type", + "default": "module" + }, + "location": { + "$ref": "#/definitions/AssetLocation" + }, + "inputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetPort" + } + }, + "outputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetPort" + } + }, + "metadata": { + "$ref": "#/definitions/AssetMetaData" + } + } + }, + "AssetLocation": { + "type": "object", + "description": "[TODO] Asset Location", + "properties": { + "uri": { + "type": "string", + "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", + "format": "url" + }, + "credentials": { + "type": "string", + "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." + } + } + }, + "AssetPort": { + "type": "object", + "description": "[TODO] Asset Port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" + } + } + }, + "AssetMetaData": { + "type": "object", + "description": "[TODO] Asset Meta Data", + "additionalProperties": { + "type": "string", + "description": "[TODO] Meta data value" + } + } + } +} diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json new file mode 100644 index 000000000000..196225bb2193 --- /dev/null +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -0,0 +1,950 @@ +{ + "swagger": "2.0", + "host": "management.azure.com", + "info": { + "title": "Machine Learning Web Services Management Client APIs", + "description": "These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:", + "version": "2016-04-01-privatepreview" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { + "put": { + "operationId": "CreateOrUpdateWebService", + "description": "Create a new Web Service or update an existing one.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/CreateOrUpdateWebServiceRequestPayloadSchema" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "get": { + "operationId": "GetWebService", + "description": "Retrieve a Web Service information by its name", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "patch": { + "operationId": "PatchWebService", + "description": "Patch an existing Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PatchWebServiceRequestPayloadSchema" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "delete": { + "operationId": "DeleteWebService", + "description": "Delete an existing Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No-Content. The Web Service is not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { + "get": { + "operationId": "GetWebServiceKeys", + "description": "Get the primary and secondary keys of a particular Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebServiceKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "operationId": "GetWebServicesInResourceGroup", + "description": "Retrieve all Web Services' information in a given Resource Group", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The list of Web Services", + "items": { + "$ref": "#/definitions/WebService" + } + }, + "nextLink": { + "type": "string", + "description": "[TODO] Next Link" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "operationId": "GetWebServicesInSubscription", + "description": "Get all Web Services' information in current Azure subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Web Services", + "items": { + "$ref": "#/definitions/WebService" + } + }, + "nextLink": { + "type": "string", + "description": "[TODO] Next Link" + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft/MachineLearning/checkNameAvailability": { + "post": { + "operationId": "CheckNameAvaliability", + "description": "Check the Web Service Name is valid and not in use", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/CheckNameAvailabilitySchema" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + } + } + } + }, + "/providers/Microsoft.MachineLearning/operations": { + "get": { + "operationId": "GetOperations", + "description": "Get all available operations of a Web Service", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Operations", + "items": { + "$ref": "#/definitions/OperationSchema" + } + } + } + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "in": "path", + "type": "string", + "required": true + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "The name of the resource group within the user's subscription.", + "in": "path", + "type": "string", + "required": true + }, + "WebServiceNameParameter": { + "name": "webServiceName", + "description": "The Web Service name which you want to reach.", + "in": "path", + "type": "string", + "required": true + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "Client Api Version.", + "required": true, + "enum": [ "2016-02-01-preview" ] + }, + "CreateOrUpdateWebServiceRequestPayloadSchema": { + "in": "body", + "name": "createOrUpdatePayload", + "description": "The payload to create or update a Web Service", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } + }, + "PatchWebServiceRequestPayloadSchema": { + "in": "body", + "name": "patchPayload", + "description": "[TODO] Patch Web Service Request Payload. It indicates all fields could be pacthed.", + "required": true, + "schema": { + "type": "object", + "title": "patchPayload", + "properties": { + "tags": { + "$ref": "#/definitions/Tags" + }, + "properties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the Web Service" + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys" + }, + "realtimeConfiguration": { + "$ref": "#/definitions/RealtimeConfiguration" + }, + "diagnostics": { + "$ref": "#/definitions/Diagnostics" + } + } + }, + "sku": { + "type": "object", + "description": "[TODO] SKU", + "properties": { + "name": { + "type": "string", + "description": "[TODO] Name" + }, + "tier": { + "type": "string", + "description": "[TODO] Tier" + } + } + } + } + } + }, + "CheckNameAvailabilitySchema": { + "in": "body", + "name": "checkNameAvailabilityPayload", + "description": "The payload to check name availability", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Web Service Name" + }, + "type": { + "type": "string", + "description": "The Web Service Type" + } + } + } + } + }, + "definitions": { + "WebService": { + "type": "object", + "title": "[TODO] The Web Service Object", + "properties": { + "location": { + "type": "string", + "description": "The Azure region where the web service is deployed." + }, + "tags": { + "$ref": "#/definitions/Tags" + }, + "properties": { + "$ref": "#/definitions/WebServiceProperties" + } + } + }, + "WebServiceProperties": { + "type": "object", + "description": "The definition of the web service being deployed.", + "required": [ + "packageType" + ], + "discriminator": "packageType", + "properties": { + "description": { + "type": "string", + "description": "The description the Web Service" + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys" + }, + "operationModes": { + "type": "array", + "description": "[TODO] Operation Modes", + "items": { + "type": "string", + "description": "[TODO] Operation Mode" + } + }, + "realtimeConfiguration": { + "$ref": "#/definitions/RealtimeConfiguration" + }, + "batchConfiguration": { + "$ref": "#/definitions/BatchConfiguration" + }, + "readOnly": { + "type": "boolean", + "description": "True, if the Web Service should be read-only; False, otherwise" + }, + "diagnostics": { + "$ref": "#/definitions/Diagnostics" + }, + "storageAccount": { + "$ref": "#/definitions/StorageAccount" + }, + "machineLearningWorkspace": { + "$ref": "#/definitions/MachineLearningWorkspace" + }, + "input": { + "$ref": "#/definitions/ModuleInterface" + }, + "output": { + "$ref": "#/definitions/ModuleInterface" + }, + "assets": { + "$ref": "#/definitions/AssetProperties" + }, + "parameters": { + "type": "object", + "description": "[TODO] Parameters of module package", + "additionalProperties": { + "type": "string" + } + }, + "packageType": { + "type": "string", + "description": "[TODO] Module package type", + "enum": [ + "Code", + "Graph" + ] + } + } + }, + "WebServicePropertiesForGraph": { + "description": "[TODO] Payload for Graph package", + "x-ms-discriminator-value": "Graph", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Graph Package", + "properties": { + "nodes": { + "type": "object", + "description": "[TODO] Graph nodes collection", + "additionalProperties": { + "$ref": "#/definitions/GraphNode" + } + }, + "edges": { + "type": "array", + "description": "[TODO] List of Graph Edges", + "items": { + "$ref": "#/definitions/GraphEdge" + } + }, + "graphParameters": { + "type": "object", + "description": "[TODO] Graph parameter collection", + "additionalProperties": { + "$ref": "#/definitions/GraphParameter" + } + } + } + } + } + }, + "WebServicePropertiesForCode": { + "description": "[TODO] Payload for Code package", + "x-ms-discriminator-value": "Code", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Code Package", + "properties": { + "language": { + "type": "string", + "description": "[TODO] The language of source code", + "enum": [ + "Python-2.7", + "R-3.1" + ] + }, + "sourceCode": { + "type": "string", + "description": "[TODO] The source code" + }, + "zipFileAssetId": { + "type": "string", + "description": "[TODO] Zip file's Asset ID" + } + } + } + } + }, + "GraphNode": { + "type": "object", + "description": "[TODO] Graph Node", + "properties": { + "assetId": { + "type": "string", + "description": "[TODO] Asset ID" + }, + "inputId": { + "type": "string", + "description": "[TODO] Input ID" + }, + "outputId": { + "type": "string", + "description": "[TODO] Output ID" + }, + "parameters": { + "type": "object", + "description": "[TODO] Node Parameters", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GraphEdge": { + "type": "object", + "description": "[TODO] Graph edge", + "properties": { + "sourceNode": { + "type": "string", + "description": "[TODO] Edge source" + }, + "sourceOutputPort": { + "type": "string", + "description": "[TODO] Source node output port" + }, + "targetNode": { + "type": "string", + "description": "[TODO] Edge target" + }, + "targetInputPort": { + "type": "string", + "description": "[TODO] Target node input port" + } + } + }, + "GraphParameter": { + "type": "object", + "description": "[TODO] Graph Parameter", + "properties": { + "description": { + "type": "string", + "description": "[TODO] Description of this Graph parameter" + }, + "defaultValue": { + "type": "string", + "description": "[TODO] The default value of this parameter. Could be null" + }, + "links": { + "type": "array", + "description": "[TODO] Links of this parameter", + "items": { + "$ref": "#/definitions/GraphParameterLink" + } + } + } + }, + "GraphParameterLink": { + "type": "object", + "description": "[TODO] The link in Graph Paramter", + "properties": { + "nodeId": { + "type": "string", + "description": "[TODO] The node ID" + }, + "parameterId": { + "type": "string", + "description": "[TODO] The parameter ID" + } + } + }, + "OperationSchema": { + "type": "object", + "description": "[TODO] The Web Service Operation Description", + "properties": { + "name": { + "type": "string", + "description": "The operation name" + }, + "display": { + "type": "object", + "description": "[TODO] Display", + "properties": { + "provider": { + "type": "string", + "description": "[TODO] Provider", + "default": "Machine Learning" + }, + "resource": { + "type": "string", + "description": "[TODO] Resource", + "default": "Web Service" + }, + "operation": { + "type": "string", + "description": "[TODO] Operation" + }, + "description": { + "type": "string", + "description": "[TODO] Description" + } + } + }, + "origin": { + "type": "string", + "description": "[TODO] Origin", + "enum": [ + "user", + "system", + "user, system" + ] + } + } + }, + "Tags": { + "type": "object", + "description": "The tags associated with this web service.", + "properties": { + "Experiement Location": { + "type": "string", + "description": "[TODO] Experiement Run Location" + } + } + }, + "RealtimeConfiguration": { + "type": "object", + "description": "Configuration settings for RRS", + "properties": { + "maxConcurrentCalls": { + "type": "integer", + "description": "[TODO] Max Concurrent Calls" + }, + "maxMemoryInMB": { + "type": "integer", + "description": "[TODO] Max Memory in MB" + }, + "maxDurationInSeconds": { + "type": "integer", + "description": "[TODO] Max Duration in Seconds" + } + } + }, + "BatchConfiguration": { + "type": "object", + "description": "[TODO] Batch Configuration", + "properties": { + "JobDriver": { + "type": "string", + "description": "[TODO] version, optional, etc." + }, + "Cluster": { + "$ref": "#/definitions/ClusterDefinition" + } + } + }, + "ClusterDefinition": { + "type": "object", + "description": "[TODO] Properties of GraphSharp", + "properties": { + "id": { + "type": "string", + "description": "ARM HDI cluster ID" + } + } + }, + "Diagnostics": { + "type": "object", + "description": "The Diagnostics Settings", + "properties": { + "level": { + "type": "string", + "description": "Trace Level: None, Error, All" + }, + "expiry": { + "type": "string", + "description": "[TODO] Expiry" + } + } + }, + "StorageAccount": { + "type": "object", + "description": "[TODO] The Storage Account used in GraphSharp", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The Storage Account ID" + } + } + }, + "MachineLearningWorkspace": { + "type": "object", + "description": "[TODO] The Machine Learning Workspace", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The Workspace ID" + } + } + }, + "WebServiceKeys": { + "type": "object", + "description": "Web Service Keys", + "properties": { + "prmiary": { + "type": "string", + "description": "The Primary Key" + }, + "secondary": { + "type": "string", + "description": "The Secondary Key" + } + } + }, + "CheckNameResult": { + "type": "object", + "properties": { + "nameAvaliable": { + "type": "boolean", + "description": "True, if the name is available; False, otherwise" + }, + "reason": { + "type": "string", + "description": "The reason why if it is not available", + "enum": [ + "Invalid", + "AlreadyExists" + ] + }, + "message": { + "type": "string", + "description": ": The message from the server" + } + } + }, + "ModuleInterface": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Interface Title" + }, + "description": { + "type": "string", + "description": "[TODO] Description of the Interface" + }, + "type": { + "type": "string", + "description": "[TODO] Interface properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AfxDataTable" + } + } + } + }, + "AssetProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetItem" + } + }, + "AfxDataTable": { + "type": "object", + "description": "[TODO] Afx data table", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Table title" + }, + "description": { + "type": "string", + "description": "[TODO] Table description" + }, + "type": { + "type": "string", + "description": "[TODO] Table properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AfxDataTableColumn" + } + } + } + }, + "AfxDataTableColumn": { + "type": "object", + "description": "[TODO] Afx data table column", + "properties": { + "type": { + "type": "string", + "description": "[TODO] Data type" + }, + "format": { + "type": "string", + "description": "[TODO] Data format" + }, + "enum": { + "type": "array", + "description": "[TODO] Options", + "items": { + "$ref": "#/definitions/AfxDataTableColumnEnum" + } + }, + "x-ms-isnullable": { + "type": "boolean", + "description": "[TODO] Is nullable" + }, + "x-ms-isordered": { + "type": "boolean", + "description": "[TODO] Is enum in order" + } + } + }, + "AfxDataTableColumnEnum": { + "type": "string", + "description": "[TODO] Enum item" + }, + "AssetItem": { + "type": "object", + "description": "[TODO] Asset Name", + "properties": { + "name": { + "type": "string", + "description": "Module friendly name" + }, + "type": { + "type": "string", + "description": "Module type", + "default": "module" + }, + "location": { + "$ref": "#/definitions/AssetLocation" + }, + "inputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetPort" + } + }, + "outputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetPort" + } + }, + "metadata": { + "$ref": "#/definitions/AssetMetaData" + } + } + }, + "AssetLocation": { + "type": "object", + "description": "[TODO] Asset Location", + "properties": { + "uri": { + "type": "string", + "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", + "format": "url" + }, + "credentials": { + "type": "string", + "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." + } + } + }, + "AssetPort": { + "type": "object", + "description": "[TODO] Asset Port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" + } + } + }, + "AssetMetaData": { + "type": "object", + "description": "[TODO] Asset Meta Data", + "additionalProperties": { + "type": "string", + "description": "[TODO] Meta data value" + } + } + } +} From dfe1b3ebbff677ca6c5a431caa7317178383f116 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Wed, 23 Mar 2016 16:11:31 -0700 Subject: [PATCH 02/18] Adapt swagger spec to latest RP wire contracts --- .../swagger/webservices.json | 1749 ++++++++--------- 1 file changed, 799 insertions(+), 950 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index 196225bb2193..63ba5b90b2dd 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -1,950 +1,799 @@ -{ - "swagger": "2.0", - "host": "management.azure.com", - "info": { - "title": "Machine Learning Web Services Management Client APIs", - "description": "These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:", - "version": "2016-04-01-privatepreview" - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { - "put": { - "operationId": "CreateOrUpdateWebService", - "description": "Create a new Web Service or update an existing one.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/CreateOrUpdateWebServiceRequestPayloadSchema" - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/WebService" - } - } - } - }, - "get": { - "operationId": "GetWebService", - "description": "Retrieve a Web Service information by its name", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebService" - } - } - } - }, - "patch": { - "operationId": "PatchWebService", - "description": "Patch an existing Web Service", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/PatchWebServiceRequestPayloadSchema" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebService" - } - } - } - }, - "delete": { - "operationId": "DeleteWebService", - "description": "Delete an existing Web Service", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No-Content. The Web Service is not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { - "get": { - "operationId": "GetWebServiceKeys", - "description": "Get the primary and secondary keys of a particular Web Service", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebServiceKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { - "get": { - "operationId": "GetWebServicesInResourceGroup", - "description": "Retrieve all Web Services' information in a given Resource Group", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "The list of Web Services", - "items": { - "$ref": "#/definitions/WebService" - } - }, - "nextLink": { - "type": "string", - "description": "[TODO] Next Link" - } - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { - "get": { - "operationId": "GetWebServicesInSubscription", - "description": "Get all Web Services' information in current Azure subscription", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "List of Web Services", - "items": { - "$ref": "#/definitions/WebService" - } - }, - "nextLink": { - "type": "string", - "description": "[TODO] Next Link" - } - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft/MachineLearning/checkNameAvailability": { - "post": { - "operationId": "CheckNameAvaliability", - "description": "Check the Web Service Name is valid and not in use", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/CheckNameAvailabilitySchema" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CheckNameResult" - } - } - } - } - }, - "/providers/Microsoft.MachineLearning/operations": { - "get": { - "operationId": "GetOperations", - "description": "Get all available operations of a Web Service", - "parameters": [ - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "List of Operations", - "items": { - "$ref": "#/definitions/OperationSchema" - } - } - } - } - } - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "in": "path", - "type": "string", - "required": true - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "description": "The name of the resource group within the user's subscription.", - "in": "path", - "type": "string", - "required": true - }, - "WebServiceNameParameter": { - "name": "webServiceName", - "description": "The Web Service name which you want to reach.", - "in": "path", - "type": "string", - "required": true - }, - "APIVersionParameter": { - "in": "query", - "name": "api-version", - "type": "string", - "description": "Client Api Version.", - "required": true, - "enum": [ "2016-02-01-preview" ] - }, - "CreateOrUpdateWebServiceRequestPayloadSchema": { - "in": "body", - "name": "createOrUpdatePayload", - "description": "The payload to create or update a Web Service", - "required": true, - "schema": { - "$ref": "#/definitions/WebService" - } - }, - "PatchWebServiceRequestPayloadSchema": { - "in": "body", - "name": "patchPayload", - "description": "[TODO] Patch Web Service Request Payload. It indicates all fields could be pacthed.", - "required": true, - "schema": { - "type": "object", - "title": "patchPayload", - "properties": { - "tags": { - "$ref": "#/definitions/Tags" - }, - "properties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the Web Service" - }, - "keys": { - "$ref": "#/definitions/WebServiceKeys" - }, - "realtimeConfiguration": { - "$ref": "#/definitions/RealtimeConfiguration" - }, - "diagnostics": { - "$ref": "#/definitions/Diagnostics" - } - } - }, - "sku": { - "type": "object", - "description": "[TODO] SKU", - "properties": { - "name": { - "type": "string", - "description": "[TODO] Name" - }, - "tier": { - "type": "string", - "description": "[TODO] Tier" - } - } - } - } - } - }, - "CheckNameAvailabilitySchema": { - "in": "body", - "name": "checkNameAvailabilityPayload", - "description": "The payload to check name availability", - "required": true, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The Web Service Name" - }, - "type": { - "type": "string", - "description": "The Web Service Type" - } - } - } - } - }, - "definitions": { - "WebService": { - "type": "object", - "title": "[TODO] The Web Service Object", - "properties": { - "location": { - "type": "string", - "description": "The Azure region where the web service is deployed." - }, - "tags": { - "$ref": "#/definitions/Tags" - }, - "properties": { - "$ref": "#/definitions/WebServiceProperties" - } - } - }, - "WebServiceProperties": { - "type": "object", - "description": "The definition of the web service being deployed.", - "required": [ - "packageType" - ], - "discriminator": "packageType", - "properties": { - "description": { - "type": "string", - "description": "The description the Web Service" - }, - "keys": { - "$ref": "#/definitions/WebServiceKeys" - }, - "operationModes": { - "type": "array", - "description": "[TODO] Operation Modes", - "items": { - "type": "string", - "description": "[TODO] Operation Mode" - } - }, - "realtimeConfiguration": { - "$ref": "#/definitions/RealtimeConfiguration" - }, - "batchConfiguration": { - "$ref": "#/definitions/BatchConfiguration" - }, - "readOnly": { - "type": "boolean", - "description": "True, if the Web Service should be read-only; False, otherwise" - }, - "diagnostics": { - "$ref": "#/definitions/Diagnostics" - }, - "storageAccount": { - "$ref": "#/definitions/StorageAccount" - }, - "machineLearningWorkspace": { - "$ref": "#/definitions/MachineLearningWorkspace" - }, - "input": { - "$ref": "#/definitions/ModuleInterface" - }, - "output": { - "$ref": "#/definitions/ModuleInterface" - }, - "assets": { - "$ref": "#/definitions/AssetProperties" - }, - "parameters": { - "type": "object", - "description": "[TODO] Parameters of module package", - "additionalProperties": { - "type": "string" - } - }, - "packageType": { - "type": "string", - "description": "[TODO] Module package type", - "enum": [ - "Code", - "Graph" - ] - } - } - }, - "WebServicePropertiesForGraph": { - "description": "[TODO] Payload for Graph package", - "x-ms-discriminator-value": "Graph", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" - } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Graph Package", - "properties": { - "nodes": { - "type": "object", - "description": "[TODO] Graph nodes collection", - "additionalProperties": { - "$ref": "#/definitions/GraphNode" - } - }, - "edges": { - "type": "array", - "description": "[TODO] List of Graph Edges", - "items": { - "$ref": "#/definitions/GraphEdge" - } - }, - "graphParameters": { - "type": "object", - "description": "[TODO] Graph parameter collection", - "additionalProperties": { - "$ref": "#/definitions/GraphParameter" - } - } - } - } - } - }, - "WebServicePropertiesForCode": { - "description": "[TODO] Payload for Code package", - "x-ms-discriminator-value": "Code", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" - } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Code Package", - "properties": { - "language": { - "type": "string", - "description": "[TODO] The language of source code", - "enum": [ - "Python-2.7", - "R-3.1" - ] - }, - "sourceCode": { - "type": "string", - "description": "[TODO] The source code" - }, - "zipFileAssetId": { - "type": "string", - "description": "[TODO] Zip file's Asset ID" - } - } - } - } - }, - "GraphNode": { - "type": "object", - "description": "[TODO] Graph Node", - "properties": { - "assetId": { - "type": "string", - "description": "[TODO] Asset ID" - }, - "inputId": { - "type": "string", - "description": "[TODO] Input ID" - }, - "outputId": { - "type": "string", - "description": "[TODO] Output ID" - }, - "parameters": { - "type": "object", - "description": "[TODO] Node Parameters", - "additionalProperties": { - "type": "string" - } - } - } - }, - "GraphEdge": { - "type": "object", - "description": "[TODO] Graph edge", - "properties": { - "sourceNode": { - "type": "string", - "description": "[TODO] Edge source" - }, - "sourceOutputPort": { - "type": "string", - "description": "[TODO] Source node output port" - }, - "targetNode": { - "type": "string", - "description": "[TODO] Edge target" - }, - "targetInputPort": { - "type": "string", - "description": "[TODO] Target node input port" - } - } - }, - "GraphParameter": { - "type": "object", - "description": "[TODO] Graph Parameter", - "properties": { - "description": { - "type": "string", - "description": "[TODO] Description of this Graph parameter" - }, - "defaultValue": { - "type": "string", - "description": "[TODO] The default value of this parameter. Could be null" - }, - "links": { - "type": "array", - "description": "[TODO] Links of this parameter", - "items": { - "$ref": "#/definitions/GraphParameterLink" - } - } - } - }, - "GraphParameterLink": { - "type": "object", - "description": "[TODO] The link in Graph Paramter", - "properties": { - "nodeId": { - "type": "string", - "description": "[TODO] The node ID" - }, - "parameterId": { - "type": "string", - "description": "[TODO] The parameter ID" - } - } - }, - "OperationSchema": { - "type": "object", - "description": "[TODO] The Web Service Operation Description", - "properties": { - "name": { - "type": "string", - "description": "The operation name" - }, - "display": { - "type": "object", - "description": "[TODO] Display", - "properties": { - "provider": { - "type": "string", - "description": "[TODO] Provider", - "default": "Machine Learning" - }, - "resource": { - "type": "string", - "description": "[TODO] Resource", - "default": "Web Service" - }, - "operation": { - "type": "string", - "description": "[TODO] Operation" - }, - "description": { - "type": "string", - "description": "[TODO] Description" - } - } - }, - "origin": { - "type": "string", - "description": "[TODO] Origin", - "enum": [ - "user", - "system", - "user, system" - ] - } - } - }, - "Tags": { - "type": "object", - "description": "The tags associated with this web service.", - "properties": { - "Experiement Location": { - "type": "string", - "description": "[TODO] Experiement Run Location" - } - } - }, - "RealtimeConfiguration": { - "type": "object", - "description": "Configuration settings for RRS", - "properties": { - "maxConcurrentCalls": { - "type": "integer", - "description": "[TODO] Max Concurrent Calls" - }, - "maxMemoryInMB": { - "type": "integer", - "description": "[TODO] Max Memory in MB" - }, - "maxDurationInSeconds": { - "type": "integer", - "description": "[TODO] Max Duration in Seconds" - } - } - }, - "BatchConfiguration": { - "type": "object", - "description": "[TODO] Batch Configuration", - "properties": { - "JobDriver": { - "type": "string", - "description": "[TODO] version, optional, etc." - }, - "Cluster": { - "$ref": "#/definitions/ClusterDefinition" - } - } - }, - "ClusterDefinition": { - "type": "object", - "description": "[TODO] Properties of GraphSharp", - "properties": { - "id": { - "type": "string", - "description": "ARM HDI cluster ID" - } - } - }, - "Diagnostics": { - "type": "object", - "description": "The Diagnostics Settings", - "properties": { - "level": { - "type": "string", - "description": "Trace Level: None, Error, All" - }, - "expiry": { - "type": "string", - "description": "[TODO] Expiry" - } - } - }, - "StorageAccount": { - "type": "object", - "description": "[TODO] The Storage Account used in GraphSharp", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The Storage Account ID" - } - } - }, - "MachineLearningWorkspace": { - "type": "object", - "description": "[TODO] The Machine Learning Workspace", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The Workspace ID" - } - } - }, - "WebServiceKeys": { - "type": "object", - "description": "Web Service Keys", - "properties": { - "prmiary": { - "type": "string", - "description": "The Primary Key" - }, - "secondary": { - "type": "string", - "description": "The Secondary Key" - } - } - }, - "CheckNameResult": { - "type": "object", - "properties": { - "nameAvaliable": { - "type": "boolean", - "description": "True, if the name is available; False, otherwise" - }, - "reason": { - "type": "string", - "description": "The reason why if it is not available", - "enum": [ - "Invalid", - "AlreadyExists" - ] - }, - "message": { - "type": "string", - "description": ": The message from the server" - } - } - }, - "ModuleInterface": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Interface Title" - }, - "description": { - "type": "string", - "description": "[TODO] Description of the Interface" - }, - "type": { - "type": "string", - "description": "[TODO] Interface properties' type. Always use 'object' here.", - "default": "object" - }, - "properties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AfxDataTable" - } - } - } - }, - "AssetProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetItem" - } - }, - "AfxDataTable": { - "type": "object", - "description": "[TODO] Afx data table", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Table title" - }, - "description": { - "type": "string", - "description": "[TODO] Table description" - }, - "type": { - "type": "string", - "description": "[TODO] Table properties' type. Always use 'object' here.", - "default": "object" - }, - "properties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AfxDataTableColumn" - } - } - } - }, - "AfxDataTableColumn": { - "type": "object", - "description": "[TODO] Afx data table column", - "properties": { - "type": { - "type": "string", - "description": "[TODO] Data type" - }, - "format": { - "type": "string", - "description": "[TODO] Data format" - }, - "enum": { - "type": "array", - "description": "[TODO] Options", - "items": { - "$ref": "#/definitions/AfxDataTableColumnEnum" - } - }, - "x-ms-isnullable": { - "type": "boolean", - "description": "[TODO] Is nullable" - }, - "x-ms-isordered": { - "type": "boolean", - "description": "[TODO] Is enum in order" - } - } - }, - "AfxDataTableColumnEnum": { - "type": "string", - "description": "[TODO] Enum item" - }, - "AssetItem": { - "type": "object", - "description": "[TODO] Asset Name", - "properties": { - "name": { - "type": "string", - "description": "Module friendly name" - }, - "type": { - "type": "string", - "description": "Module type", - "default": "module" - }, - "location": { - "$ref": "#/definitions/AssetLocation" - }, - "inputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetPort" - } - }, - "outputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetPort" - } - }, - "metadata": { - "$ref": "#/definitions/AssetMetaData" - } - } - }, - "AssetLocation": { - "type": "object", - "description": "[TODO] Asset Location", - "properties": { - "uri": { - "type": "string", - "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", - "format": "url" - }, - "credentials": { - "type": "string", - "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." - } - } - }, - "AssetPort": { - "type": "object", - "description": "[TODO] Asset Port", - "properties": { - "type": { - "type": "string", - "description": "[TODO] dataset or zip" - } - } - }, - "AssetMetaData": { - "type": "object", - "description": "[TODO] Asset Meta Data", - "additionalProperties": { - "type": "string", - "description": "[TODO] Meta data value" - } - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Machine Learning Web Services Management Client APIs", + "description": "These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:", + "version": "2016-04-01-privatepreview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { + "put": { + "operationId": "CreateOrUpdateWebService", + "description": "Create a new Web Service or update an existing one.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/CreateOrUpdateWebServiceRequestPayloadSchema" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "get": { + "operationId": "GetWebService", + "description": "Retrieve a Web Service information by its name", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "patch": { + "operationId": "PatchWebService", + "description": "Patch an existing Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PatchWebServiceRequestPayloadSchema" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "delete": { + "operationId": "DeleteWebService", + "description": "Delete an existing Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No-Content. The Web Service is not found." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { + "get": { + "operationId": "GetWebServiceKeys", + "description": "Get the primary and secondary keys of a particular Web Service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebServiceKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "operationId": "GetWebServicesInResourceGroup", + "description": "Retrieve all Web Services' information in a given Resource Group", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebServicesList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "operationId": "GetWebServicesInSubscription", + "description": "Get all Web Services' information in current Azure subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebServicesList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft/MachineLearning/checkNameAvailability": { + "post": { + "operationId": "CheckNameAvaliability", + "description": "Check the Web Service Name is valid and not in use", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/CheckNameAvailabilitySchema" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + } + } + } + }, + "/providers/Microsoft.MachineLearning/operations": { + "get": { + "operationId": "GetOperations", + "description": "Get all available operations of a Web Service", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Operations", + "items": { + "$ref": "#/definitions/OperationSchema" + } + } + } + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "in": "path", + "type": "string", + "required": true + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "The name of the resource group within the user's subscription.", + "in": "path", + "type": "string", + "required": true + }, + "WebServiceNameParameter": { + "name": "webServiceName", + "description": "The Web Service name which you want to reach.", + "in": "path", + "type": "string", + "required": true + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "Client Api Version.", + "required": true, + "enum": [ "2016-02-01-preview" ] + }, + "CreateOrUpdateWebServiceRequestPayloadSchema": { + "in": "body", + "name": "createOrUpdatePayload", + "description": "The payload to create or update a Web Service", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } + }, + "PatchWebServiceRequestPayloadSchema": { + "in": "body", + "name": "patchPayload", + "description": "[TODO] Patch Web Service Request Payload. It indicates all fields could be pacthed.", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } + }, + "CheckNameAvailabilitySchema": { + "in": "body", + "name": "checkNameAvailabilityPayload", + "description": "The payload to check name availability", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Web Service Name" + }, + "type": { + "type": "string", + "description": "The Web Service Type" + } + } + } + } + }, + "definitions": { + "WebService": { + "type": "object", + "title": "[TODO] The Web Service Object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebServiceProperties" + } + } + }, + "WebServiceProperties": { + "type": "object", + "description": "The definition of the web service being deployed.", + "properties": { + "description": { + "type": "string", + "description": "The description the web service" + }, + "createdOn": { + "type": "string", + "description": "The moment of time the web service was created.", + "format": "date-time" + }, + "modifiedOn": { + "type": "string", + "description": "The last moment of time the web service was last modified.", + "format": "date-time" + }, + "provisioningState": { + "type": "string", + "description": "[TODO] web service's provisioning state", + "enum": [ + "Unknown", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys" + }, + "readOnly": { + "type": "boolean", + "description": "True, if the Web Service should be read-only; False, otherwise" + }, + "swaggerUri": { + "type": "string", + "description": "The uri for the swagger spec associated with this web service" + }, + "realtimeConfiguration": { + "$ref": "#/definitions/RealtimeConfiguration" + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsConfiguration" + }, + "storageAccount": { + "$ref": "#/definitions/StorageAccount" + }, + "machineLearningWorkspace": { + "$ref": "#/definitions/MachineLearningWorkspace" + }, + "commitmentPlan": { + "$ref": "#/definitions/CommitmentPlan" + }, + "input": { + "type": "string", + "description": "[TODO] The web service's input schema defined as a JSON object." + }, + "output": { + "type": "string", + "description": "[TODO] The web service's output schema defined as a JSON object." + }, + "assets": { + "$ref": "#/definitions/AssetProperties" + }, + "parameters": { + "type": "object", + "description": "[TODO] Parameters of module package", + "additionalProperties": { + "type": "string" + } + }, + "packageType": { + "type": "string", + "description": "[TODO] Module package type", + "enum": [ + "Code", + "Graph" + ] + }, + "package": { + "type": "string", + "description": "[TODO] The web service's package defined as a JSON object." + } + }, + "required": [ + "packageType" + ] + }, + "WebServiceKeys": { + "type": "object", + "description": "Web Service Keys", + "properties": { + "primary": { + "type": "string", + "description": "The Primary Key" + }, + "secondary": { + "type": "string", + "description": "The Secondary Key" + } + } + }, + "PaginatedWebServicesList": { + "type": "object", + "description": "[TODO] Paginated list of web services", + "properties": { + "values": { + "type": "array", + "description": "List of Web Services", + "items": { + "$ref": "#/definitions/WebService" + } + }, + "nextLink": { + "type": "string", + "description": "[TODO] Next Link" + } + } + }, + "GraphNode": { + "type": "object", + "description": "[TODO] Graph Node", + "properties": { + "assetId": { + "type": "string", + "description": "[TODO] Asset ID" + }, + "inputId": { + "type": "string", + "description": "[TODO] Input ID" + }, + "outputId": { + "type": "string", + "description": "[TODO] Output ID" + }, + "parameters": { + "type": "object", + "description": "[TODO] Node Parameters", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GraphEdge": { + "type": "object", + "description": "[TODO] Graph edge", + "properties": { + "sourceNode": { + "type": "string", + "description": "[TODO] Edge source" + }, + "sourceOutputPort": { + "type": "string", + "description": "[TODO] Source node output port" + }, + "targetNode": { + "type": "string", + "description": "[TODO] Edge target" + }, + "targetInputPort": { + "type": "string", + "description": "[TODO] Target node input port" + } + } + }, + "GraphParameter": { + "type": "object", + "description": "[TODO] Graph Parameter", + "properties": { + "description": { + "type": "string", + "description": "[TODO] Description of this Graph parameter" + }, + "defaultValue": { + "type": "string", + "description": "[TODO] The default value of this parameter. Could be null" + }, + "links": { + "type": "array", + "description": "[TODO] Links of this parameter", + "items": { + "$ref": "#/definitions/GraphParameterLink" + } + } + } + }, + "GraphParameterLink": { + "type": "object", + "description": "[TODO] The link in Graph Paramter", + "properties": { + "nodeId": { + "type": "string", + "description": "[TODO] The node ID" + }, + "parameterId": { + "type": "string", + "description": "[TODO] The parameter ID" + } + } + }, + "OperationSchema": { + "type": "object", + "description": "[TODO] The Web Service Operation Description", + "properties": { + "name": { + "type": "string", + "description": "The operation name" + }, + "display": { + "type": "object", + "description": "[TODO] Display", + "properties": { + "provider": { + "type": "string", + "description": "[TODO] Provider", + "default": "Machine Learning" + }, + "resource": { + "type": "string", + "description": "[TODO] Resource", + "default": "Web Service" + }, + "operation": { + "type": "string", + "description": "[TODO] Operation" + }, + "description": { + "type": "string", + "description": "[TODO] Description" + } + } + }, + "origin": { + "type": "string", + "description": "[TODO] Origin", + "enum": [ + "user", + "system", + "user, system" + ] + } + } + }, + "RealtimeConfiguration": { + "type": "object", + "description": "Configuration settings for RRS", + "properties": { + "maxConcurrentCalls": { + "type": "integer", + "description": "[TODO] Max Concurrent Calls" + } + } + }, + "DiagnosticsConfiguration": { + "type": "object", + "description": "The Diagnostics Settings", + "properties": { + "level": { + "type": "string", + "description": "Trace Level: None, Error, All", + "enum": [ + "None", + "Error", + "All" + ] + }, + "expiry": { + "type": "string", + "description": "[TODO] Expiry" + } + } + }, + "StorageAccount": { + "type": "object", + "description": "[TODO] The Storage Account used in GraphSharp", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The storage account's Id" + }, + "name": { + "type": "string", + "description": "[TODO] The storage account's name" + }, + "primaryKey": { + "type": "string", + "description": "[TODO] The storage account's primary key" + }, + "secondaryKey": { + "type": "string", + "description": "[TODO] The storage account's secondary key" + } + } + }, + "MachineLearningWorkspace": { + "type": "object", + "description": "[TODO] The machine learning workspace", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The Workspace ID" + } + } + }, + "CommitmentPlan": { + "type": "object", + "description": "[TODO] The commitment plan associated with this web service", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The plan's ID" + } + } + }, + "AssetProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetItem" + } + }, + "AssetItem": { + "type": "object", + "description": "[TODO] Service asset details", + "properties": { + "name": { + "type": "string", + "description": "Module friendly name" + }, + "type": { + "type": "string", + "description": "Module type", + "default": "module" + }, + "location": { + "$ref": "#/definitions/AssetLocation" + }, + "inputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetPort" + } + }, + "outputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetPort" + } + }, + "parameters": { + "$ref": "#/definitions/AssetParameters" + }, + "metadata": { + "$ref": "#/definitions/AssetMetadata" + } + } + }, + "AssetLocation": { + "type": "object", + "description": "[TODO] Asset Location", + "properties": { + "uri": { + "type": "string", + "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", + "format": "url" + }, + "credentials": { + "type": "string", + "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." + } + } + }, + "AssetPort": { + "type": "object", + "description": "[TODO] Asset Port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" + } + } + }, + "AssetParameters": { + "type": "object", + "description": "[TODO] Asset parameters", + "additionalProperties": { + "type": "string", + "description": "[TODO] Parameter value" + } + }, + "AssetMetadata": { + "type": "object", + "description": "[TODO] Asset metadata", + "additionalProperties": { + "type": "string", + "description": "[TODO] Metadata value" + } + }, + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "description": "Resource Id", + "type": "string" + }, + "name": { + "description": "Resource Name", + "type": "string" + }, + "location": { + "description": "Resource Location", + "type": "string" + }, + "type": { + "description": "Resource type", + "type": "string" + }, + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CheckNameResult": { + "type": "object", + "properties": { + "nameAvaliable": { + "type": "boolean", + "description": "True, if the name is available; False, otherwise" + }, + "reason": { + "type": "string", + "description": "The reason why if it is not available", + "enum": [ + "Invalid", + "AlreadyExists" + ] + }, + "message": { + "type": "string", + "description": ": The message from the server" + } + } + } + } +} \ No newline at end of file From 114b44577d248e2b33075a089e3312d71e6b628f Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Mon, 28 Mar 2016 16:39:17 -0700 Subject: [PATCH 03/18] Updated spec to refelct current state of RP / RRS wire contracts --- .../swagger/webservices.json | 395 +++++++++++++----- 1 file changed, 300 insertions(+), 95 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index 63ba5b90b2dd..87d7d7270ecc 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -345,6 +345,10 @@ "WebServiceProperties": { "type": "object", "description": "The definition of the web service being deployed.", + "required": [ + "packageType" + ], + "discriminator": "packageType", "properties": { "description": { "type": "string", @@ -399,12 +403,10 @@ "$ref": "#/definitions/CommitmentPlan" }, "input": { - "type": "string", - "description": "[TODO] The web service's input schema defined as a JSON object." + "$ref": "#/definitions/ModuleInterfaceSchema" }, "output": { - "type": "string", - "description": "[TODO] The web service's output schema defined as a JSON object." + "$ref": "#/definitions/ModuleInterfaceSchema" }, "assets": { "$ref": "#/definitions/AssetProperties" @@ -423,15 +425,79 @@ "Code", "Graph" ] - }, + } + } + }, + "WebServicePropertiesForGraph": { + "description": "[TODO] Payload for Graph package", + "x-ms-discriminator-value": "Graph", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { "package": { - "type": "string", - "description": "[TODO] The web service's package defined as a JSON object." + "type": "object", + "description": "[TODO] Graph Package", + "properties": { + "nodes": { + "type": "array", + "description": "[TODO] Graph nodes collection", + "items": { + "$ref": "#/definitions/GraphNodeKeyPair" + } + }, + "edges": { + "type": "array", + "description": "[TODO] List of Graph Edges", + "items": { + "$ref": "#/definitions/GraphEdge" + } + }, + "graphParameters": { + "type": "array", + "description": "[TODO] Graph parameter collection", + "items": { + "$ref": "#/definitions/GraphParameterKeyPair" + } + } + } } - }, - "required": [ - "packageType" - ] + } + }, + "WebServicePropertiesForCode": { + "description": "[TODO] Payload for Code package", + "x-ms-discriminator-value": "Code", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Code Package", + "properties": { + "language": { + "type": "string", + "description": "[TODO] The language of source code", + "enum": [ + "Python-2.7", + "R-3.1" + ] + }, + "sourceCode": { + "type": "string", + "description": "[TODO] The source code" + }, + "zipFileAssetId": { + "type": "string", + "description": "[TODO] Zip file's Asset ID" + } + } + } + } }, "WebServiceKeys": { "type": "object", @@ -464,88 +530,6 @@ } } }, - "GraphNode": { - "type": "object", - "description": "[TODO] Graph Node", - "properties": { - "assetId": { - "type": "string", - "description": "[TODO] Asset ID" - }, - "inputId": { - "type": "string", - "description": "[TODO] Input ID" - }, - "outputId": { - "type": "string", - "description": "[TODO] Output ID" - }, - "parameters": { - "type": "object", - "description": "[TODO] Node Parameters", - "additionalProperties": { - "type": "string" - } - } - } - }, - "GraphEdge": { - "type": "object", - "description": "[TODO] Graph edge", - "properties": { - "sourceNode": { - "type": "string", - "description": "[TODO] Edge source" - }, - "sourceOutputPort": { - "type": "string", - "description": "[TODO] Source node output port" - }, - "targetNode": { - "type": "string", - "description": "[TODO] Edge target" - }, - "targetInputPort": { - "type": "string", - "description": "[TODO] Target node input port" - } - } - }, - "GraphParameter": { - "type": "object", - "description": "[TODO] Graph Parameter", - "properties": { - "description": { - "type": "string", - "description": "[TODO] Description of this Graph parameter" - }, - "defaultValue": { - "type": "string", - "description": "[TODO] The default value of this parameter. Could be null" - }, - "links": { - "type": "array", - "description": "[TODO] Links of this parameter", - "items": { - "$ref": "#/definitions/GraphParameterLink" - } - } - } - }, - "GraphParameterLink": { - "type": "object", - "description": "[TODO] The link in Graph Paramter", - "properties": { - "nodeId": { - "type": "string", - "description": "[TODO] The node ID" - }, - "parameterId": { - "type": "string", - "description": "[TODO] The parameter ID" - } - } - }, "OperationSchema": { "type": "object", "description": "[TODO] The Web Service Operation Description", @@ -660,6 +644,117 @@ } } }, + "ModuleInterfaceSchema": { + "type": "object", + "description": "[TODO] The swagger schema describing the service's input.", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Interface title" + }, + "description": { + "type": "string", + "description": "[TODO] Description of the interface" + }, + "format": { + "type": "string", + "description": "[TODO] Format of the interface" + }, + "type": { + "type": "string", + "description": "[TODO] Interface properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "array", + "description": "[TODO]", + "items": { + "$ref": "#/definitions/DataTableKeyValuePair" + } + } + } + }, + "DataTableSchema": { + "type": "object", + "description": "[TODO] schema for a data table", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Table title" + }, + "description": { + "type": "string", + "description": "[TODO] Table description" + }, + "type": { + "type": "string", + "description": "[TODO] Table properties' type. Always use 'object' here.", + "default": "object" + }, + "format": { + "type": "string", + "description": "[TODO] Table format" + }, + "properties": { + "type": "array", + "description": "The set of columns within the data table", + "items": { + "$ref": "#/definitions/DataTableColumnKeyPair" + } + } + } + }, + "DataTableKeyValuePair": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "$ref": "#/definitions/DataTableSchema" + } + } + }, + "DataTableColumnSchema": { + "type": "object", + "description": "[TODO] input column.", + "properties": { + "type": { + "type": "string", + "description": "[TODO] Data type" + }, + "format": { + "type": "string", + "description": "[TODO] Data format" + }, + "enum": { + "type": "array", + "description": "[TODO] Options", + "items": { + "type": "object" + } + }, + "x-ms-isnullable": { + "type": "boolean", + "description": "[TODO] Is nullable" + }, + "x-ms-isordered": { + "type": "boolean", + "description": "[TODO] Is enum in order" + } + } + }, + "DataTableColumnKeyPair": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "$ref": "#/definitions/DataTableColumnSchema" + } + } + }, "AssetProperties": { "type": "object", "additionalProperties": { @@ -743,6 +838,117 @@ "description": "[TODO] Metadata value" } }, + "GraphNode": { + "type": "object", + "description": "[TODO] Graph Node", + "properties": { + "assetId": { + "type": "string", + "description": "[TODO] Asset ID" + }, + "inputId": { + "type": "string", + "description": "[TODO] Input ID" + }, + "outputId": { + "type": "string", + "description": "[TODO] Output ID" + }, + "parameters": { + "type": "object", + "description": "[TODO] Node Parameters", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GraphNodeKeyPair": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "$ref": "#/definitions/GraphNode" + } + } + }, + "GraphEdge": { + "type": "object", + "description": "[TODO] Graph edge", + "properties": { + "sourceNodeId": { + "type": "string", + "description": "[TODO] Edge source" + }, + "sourceOutputPortId": { + "type": "string", + "description": "[TODO] Source node output port id" + }, + "targetNodeId": { + "type": "string", + "description": "[TODO] Edge target" + }, + "targetInputPortId": { + "type": "string", + "description": "[TODO] Target node input port id" + } + } + }, + "GraphParameter": { + "type": "object", + "description": "[TODO] Graph Parameters", + "properties": { + "description": { + "type": "string", + "description": "[TODO] Description of this Graph parameter" + }, + "links": { + "type": "array", + "description": "[TODO] Links of this parameter", + "items": { + "$ref": "#/definitions/GraphParameterLink" + } + }, + "parameterRules": { + "type": "array", + "description": "[TODO] Rules for this parameter", + "items": { + "$ref": "#/definitions/GraphParameterRule" + } + } + } + }, + "GraphParameterLink": { + "type": "object", + "description": "[TODO] The link in graph parameter", + "properties": { + "nodeId": { + "type": "string", + "description": "[TODO] The node ID" + }, + "parameterKey": { + "type": "string", + "description": "[TODO] The parameter key" + } + } + }, + "GraphParameterRule": { + "type": "object", + "description": "[TODO] A rule for a graph parameter" + }, + "GraphParameterKeyPair": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "$ref": "#/definitions/GraphParameter" + } + } + }, "Resource": { "required": [ "location" @@ -771,8 +977,7 @@ "type": "string" } } - }, - "x-ms-azure-resource": true + } }, "CheckNameResult": { "type": "object", From e33471abb8047176890ce80165aec0901b9e1a23 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Wed, 30 Mar 2016 10:06:03 -0700 Subject: [PATCH 04/18] More updates to the swagger schema --- .../swagger/webservices.json | 168 ++++++------------ 1 file changed, 53 insertions(+), 115 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index 87d7d7270ecc..231e2c93df37 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -383,32 +383,40 @@ "type": "boolean", "description": "True, if the Web Service should be read-only; False, otherwise" }, - "swaggerUri": { + "swaggerLocation": { "type": "string", "description": "The uri for the swagger spec associated with this web service" }, "realtimeConfiguration": { + "description": "[TODO] Realtime configuration", "$ref": "#/definitions/RealtimeConfiguration" }, "diagnostics": { + "description": "[TODO] Diagnostics settings", "$ref": "#/definitions/DiagnosticsConfiguration" }, "storageAccount": { + "description": "[TODO] BYOS description", "$ref": "#/definitions/StorageAccount" }, "machineLearningWorkspace": { + "description": "[TODO] Service workspace data", "$ref": "#/definitions/MachineLearningWorkspace" }, "commitmentPlan": { + "description": "[TODO] Service commitment plan data", "$ref": "#/definitions/CommitmentPlan" }, "input": { - "$ref": "#/definitions/ModuleInterfaceSchema" + "description": "[TODO] Service input definition", + "$ref": "#/definitions/ServiceInputOutputSpecification" }, "output": { - "$ref": "#/definitions/ModuleInterfaceSchema" + "description": "[TODO] Service output definition", + "$ref": "#/definitions/ServiceInputOutputSpecification" }, "assets": { + "description": "[TODO] Service assets", "$ref": "#/definitions/AssetProperties" }, "parameters": { @@ -424,7 +432,11 @@ "enum": [ "Code", "Graph" - ] + ], + "x-ms-enum": { + "name": "PackageType", + "modelAsString": false + } } } }, @@ -442,10 +454,10 @@ "description": "[TODO] Graph Package", "properties": { "nodes": { - "type": "array", + "type": "object", "description": "[TODO] Graph nodes collection", - "items": { - "$ref": "#/definitions/GraphNodeKeyPair" + "additionalProperties": { + "$ref": "#/definitions/GraphNode" } }, "edges": { @@ -456,10 +468,10 @@ } }, "graphParameters": { - "type": "array", + "type": "object", "description": "[TODO] Graph parameter collection", - "items": { - "$ref": "#/definitions/GraphParameterKeyPair" + "additionalProperties": { + "$ref": "#/definitions/GraphParameter" } } } @@ -594,11 +606,16 @@ "None", "Error", "All" - ] + ], + "x-ms-enum": { + "name": "DiagnosticsLevel", + "modelAsString": false + } }, "expiry": { "type": "string", - "description": "[TODO] Expiry" + "description": "[TODO] Expiry date", + "format": "date-time" } } }, @@ -606,10 +623,6 @@ "type": "object", "description": "[TODO] The Storage Account used in GraphSharp", "properties": { - "id": { - "type": "string", - "description": "[TODO] The storage account's Id" - }, "name": { "type": "string", "description": "[TODO] The storage account's name" @@ -644,7 +657,7 @@ } } }, - "ModuleInterfaceSchema": { + "ServiceInputOutputSpecification": { "type": "object", "description": "[TODO] The swagger schema describing the service's input.", "properties": { @@ -656,25 +669,21 @@ "type": "string", "description": "[TODO] Description of the interface" }, - "format": { - "type": "string", - "description": "[TODO] Format of the interface" - }, "type": { "type": "string", "description": "[TODO] Interface properties' type. Always use 'object' here.", "default": "object" }, "properties": { - "type": "array", - "description": "[TODO]", - "items": { - "$ref": "#/definitions/DataTableKeyValuePair" + "type": "object", + "description": "[TODO]", + "additionalProperties": { + "$ref": "#/definitions/TableSpecification" } } } }, - "DataTableSchema": { + "TableSpecification": { "type": "object", "description": "[TODO] schema for a data table", "properties": { @@ -691,31 +700,16 @@ "description": "[TODO] Table properties' type. Always use 'object' here.", "default": "object" }, - "format": { - "type": "string", - "description": "[TODO] Table format" - }, "properties": { - "type": "array", + "type": "object", "description": "The set of columns within the data table", - "items": { - "$ref": "#/definitions/DataTableColumnKeyPair" + "additionalProperties": { + "$ref": "#/definitions/ColumnSpecification" } } } }, - "DataTableKeyValuePair": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "$ref": "#/definitions/DataTableSchema" - } - } - }, - "DataTableColumnSchema": { + "ColumnSpecification": { "type": "object", "description": "[TODO] input column.", "properties": { @@ -744,17 +738,6 @@ } } }, - "DataTableColumnKeyPair": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "$ref": "#/definitions/DataTableColumnSchema" - } - } - }, "AssetProperties": { "type": "object", "additionalProperties": { @@ -780,20 +763,14 @@ "inputPorts": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/AssetPort" + "$ref": "#/definitions/InputPort" } }, "outputPorts": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/AssetPort" + "$ref": "#/definitions/OutputPort" } - }, - "parameters": { - "$ref": "#/definitions/AssetParameters" - }, - "metadata": { - "$ref": "#/definitions/AssetMetadata" } } }, @@ -812,9 +789,9 @@ } } }, - "AssetPort": { + "InputPort": { "type": "object", - "description": "[TODO] Asset Port", + "description": "[TODO] Asset input port", "properties": { "type": { "type": "string", @@ -822,20 +799,14 @@ } } }, - "AssetParameters": { + "OutputPort": { "type": "object", - "description": "[TODO] Asset parameters", - "additionalProperties": { - "type": "string", - "description": "[TODO] Parameter value" - } - }, - "AssetMetadata": { - "type": "object", - "description": "[TODO] Asset metadata", - "additionalProperties": { - "type": "string", - "description": "[TODO] Metadata value" + "description": "[TODO] Asset output port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" + } } }, "GraphNode": { @@ -863,17 +834,6 @@ } } }, - "GraphNodeKeyPair": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "$ref": "#/definitions/GraphNode" - } - } - }, "GraphEdge": { "type": "object", "description": "[TODO] Graph edge", @@ -882,7 +842,7 @@ "type": "string", "description": "[TODO] Edge source" }, - "sourceOutputPortId": { + "sourcePortId": { "type": "string", "description": "[TODO] Source node output port id" }, @@ -890,7 +850,7 @@ "type": "string", "description": "[TODO] Edge target" }, - "targetInputPortId": { + "targetPortId": { "type": "string", "description": "[TODO] Target node input port id" } @@ -910,13 +870,6 @@ "items": { "$ref": "#/definitions/GraphParameterLink" } - }, - "parameterRules": { - "type": "array", - "description": "[TODO] Rules for this parameter", - "items": { - "$ref": "#/definitions/GraphParameterRule" - } } } }, @@ -933,22 +886,7 @@ "description": "[TODO] The parameter key" } } - }, - "GraphParameterRule": { - "type": "object", - "description": "[TODO] A rule for a graph parameter" - }, - "GraphParameterKeyPair": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "value": { - "$ref": "#/definitions/GraphParameter" - } - } - }, + }, "Resource": { "required": [ "location" From 51bb8676850ded658064e06d7da2041907ac4cec Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Wed, 30 Mar 2016 10:19:25 -0700 Subject: [PATCH 05/18] Fetched latest changes from origin --- .../2014-09-01/swagger/remoteapp.json | 5768 +-- .../features/2015-12-01/swagger/features.json | 650 +- .../locks/2015-01-01/swagger/locks.json | 1506 +- .../2015-11-01/swagger/resources.json | 5634 +-- .../2016-02-01/swagger/resources.json | 5932 +-- .../2015-11-01/swagger/subscriptions.json | 582 +- .../2014-08-01-preview/swagger/scheduler.json | 3248 +- .../2016-01-01/swagger/scheduler.json | 3248 +- arm-search/2015-02-28/swagger/search.json | 1016 +- .../2016-01-28/swagger/servicefabric.json | 10292 ++-- arm-sql/2015-05-01/swagger/sql.json | 510 +- .../2015-05-01-preview/swagger/storage.json | 1640 +- arm-storage/2015-06-15/swagger/storage.json | 1694 +- arm-web/2015-08-01/swagger/service.json | 40612 ++++++++-------- 14 files changed, 41166 insertions(+), 41166 deletions(-) diff --git a/arm-remoteapp/2014-09-01/swagger/remoteapp.json b/arm-remoteapp/2014-09-01/swagger/remoteapp.json index 853ddf98464d..c246229d094a 100644 --- a/arm-remoteapp/2014-09-01/swagger/remoteapp.json +++ b/arm-remoteapp/2014-09-01/swagger/remoteapp.json @@ -1,2884 +1,2884 @@ -{ - "swagger": "2.0", - "info": { - "title": "RemoteAppManagementClient", - "version": "2014-09-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/{armNamespace}/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_GetAvailable", - "description": "Gets the available RemoteApp operations", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/OperationInfoList" - } - }, - "202": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/{armNamespace}/accounts/{subscriptionId}": { - "get": { - "tags": [ - "Account" - ], - "operationId": "Account_Get", - "description": "Gets the account associated with the subscription id.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AccountDetailsWrapperList" - } - }, - "202": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/{armNamespace}/accounts/{subscriptionId}/activateBilling": { - "post": { - "tags": [ - "Account" - ], - "operationId": "Account_ActivateBilling", - "description": "Activates billing for the account", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/{armNamespace}/accounts/{subscriptionId}/update": { - "post": { - "tags": [ - "Account" - ], - "operationId": "Account_Update", - "description": "Updates the account PrivacyUrl and WorkspaceName.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "accountInfo", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AccountDetailsWrapper" - }, - "description": "The new PrivacyUrl and WorkspaceName" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AccountDetailsWrapperList" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/{armNamespace}/templateImages": { - "get": { - "tags": [ - "TemplateImages" - ], - "operationId": "TemplateImage_List", - "description": "Gets available template images in the specified location", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TemplateImageList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/{armNamespace}/templateImages/{templateImageName}": { - "get": { - "tags": [ - "TemplateImages" - ], - "operationId": "TemplateImage_Get", - "description": "Gets a template image.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TemplateImage" - } - } - } - }, - "parameters": [ - { - "name": "templateImageName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the template image" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_ListInResourceGroup", - "description": "Gets the list of collections details in the resource group.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CollectionListResult" - } - }, - "202": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/providers/{armNamespace}/collections": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_ListInSubscription", - "description": "Gets the list of collections details in the subscription.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CollectionListResult" - } - }, - "202": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_Get", - "description": "Gets the collection details.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Collection" - } - }, - "202": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Collection" - ], - "operationId": "Collection_CreateOrUpdate", - "description": "Create or update a collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "details", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CollectionCreationDetailsWrapper" - }, - "description": "The details of the created or updated collection" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CollectionCreationDetailsWrapper" - } - } - } - }, - "delete": { - "tags": [ - "Collection" - ], - "operationId": "Collection_Delete", - "description": "Delete the collection", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "" - }, - "202": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/applications": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_ListPublishedApps", - "description": "Gets the list of published applications in this collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PublishedApplicationDetailsListResult" - } - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/applications/{alias}": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetPublishedApp", - "description": "Gets the specified published application in this collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PublishedApplicationDetails" - } - }, - "202": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Collection" - ], - "operationId": "Collection_PublishOrUpdateApplication", - "description": "Publishes a new application or updates a previously published application.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "applicationDetails", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationDetails" - }, - "description": "Details of the applicaton to publish or modify" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PublishingOperationResult" - } - }, - "202": { - "description": "" - } - } - }, - "delete": { - "tags": [ - "Collection" - ], - "operationId": "Collection_Unpublish", - "description": "Unpublishes published application matching the application alias (short unique name) from the collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PublishingOperationResult" - } - }, - "202": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "alias", - "in": "path", - "required": true, - "type": "string", - "description": "The alias for the application." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_ListSessions", - "description": "Gets a list of sessions on the current collection", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SessionList" - } - }, - "202": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions/{userUpn}": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetSession", - "description": "Gets the specified user's session on the current collection", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Session" - } - }, - "202": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "userUpn", - "in": "path", - "required": true, - "type": "string", - "description": "The UPN of the user" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions/{userUpn}/disconnect": { - "post": { - "tags": [ - "Collection" - ], - "operationId": "Collection_SessionDisconnect", - "description": "Disconnects the specified user", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "" - }, - "202": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "userUpn", - "in": "path", - "required": true, - "type": "string", - "description": "The UPN of the user" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions/{userUpn}/logoff": { - "post": { - "tags": [ - "Collection" - ], - "operationId": "Collection_SessionLogOff", - "description": "Logs off the specified user", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "userUpn", - "in": "path", - "required": true, - "type": "string", - "description": "The UPN of the user" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions/{userUpn}/sendMessage": { - "post": { - "tags": [ - "Collection" - ], - "operationId": "Collection_SessionSendMessage", - "description": "Sends a message to the specified user", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "messageDetails", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SessionSendMessageCommandParameter" - }, - "description": "Session message details" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "userUpn", - "in": "path", - "required": true, - "type": "string", - "description": "The UPN of the user" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/startMenuApps": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_ListStartMenuApps", - "description": "Gets the list of applications available in this collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StartMenuApplicationListResult" - } - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/startMenuApps/{applicationId}": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetStartMenuApp", - "description": "Gets the specified Start Menu application available in this collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "name": "applicationId", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the application." - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StartMenuApplication" - } - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/usageDetails": { - "post": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetUsageDetails", - "description": "Generates a CSV file of collection usage details and returns the URI", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/UsageDetailsInfo" - } - }, - "202": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - }, - { - "name": "date", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BillingDate" - }, - "description": "The year and month to get billing for" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/usageSummaries": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetUsageSummaryList", - "description": "Gets a summary of usage data for all users in the collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "name": "usageMonth", - "in": "query", - "required": true, - "type": "string", - "description": "The requested month for collection usage information" - }, - { - "name": "usageYear", - "in": "query", - "required": true, - "type": "string", - "description": "The requested year for collection usage information" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CollectionUsageSummaryList" - } - }, - "202": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/usageSummaries/{userUpn}": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetUsageSummary", - "description": "Gets a summary of collection usage data for the specified user.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "name": "usageMonth", - "in": "query", - "required": true, - "type": "string", - "description": "The requested month for collection usage information" - }, - { - "name": "usageYear", - "in": "query", - "required": true, - "type": "string", - "description": "The requested year for collection usage information" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CollectionUsageSummary" - } - }, - "202": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "userUpn", - "in": "path", - "required": true, - "type": "string", - "description": "The UPN of the user" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/metrics": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetMetrics", - "description": "Gets the list of collection metric values for specified time window.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "name": "startTimeUtc", - "in": "query", - "required": false, - "type": "string", - "description": "UTC start time for the time window formatted as 'yyyyMMdd'" - }, - { - "name": "endTimeUtc", - "in": "query", - "required": false, - "type": "string", - "description": "UTC end time for the time window formatted as 'yyyyMMdd'" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CollectionMetricsDetailsWrapper" - } - }, - "202": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/users": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetUsers", - "description": "Gets a list of all RemoteApp users associated with the given collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SecurityPrincipalList" - } - }, - "202": { - "description": "" - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/users/{userUpn}": { - "get": { - "tags": [ - "Collection" - ], - "operationId": "Collection_GetUser", - "description": "Gets a RemoteApp user by their UPN.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SecurityPrincipalInfo" - } - }, - "202": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Collection" - ], - "operationId": "Collection_AddUser", - "description": "Adds a user to the given collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "securityPrincipal", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SecurityPrincipal" - }, - "description": "A RemoteApp user to add." - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SecurityPrincipalOperationErrorDetails" - } - } - } - }, - "delete": { - "tags": [ - "Collection" - ], - "operationId": "Collection_DeleteUser", - "description": "Deletes a user from the given collection.", - "parameters": [ - { - "$ref": "#/parameters/armNamespace" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "securityPrincipal", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SecurityPrincipal" - }, - "description": "The RemoteApp user to remove." - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SecurityPrincipalOperationErrorDetails" - } - } - } - }, - "parameters": [ - { - "name": "collectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The collection name." - }, - { - "name": "userUpn", - "in": "path", - "required": true, - "type": "string", - "description": "The UPN of the user" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group" - } - ] - } - }, - "definitions": { - "AccountDetails": { - "properties": { - "accountId": { - "type": "string", - "description": "The account subscriptionId" - }, - "workspaceName": { - "type": "string", - "description": "Name of the workspace" - }, - "maxPublishedAppsPerService": { - "type": "integer", - "format": "int32", - "description": "The maximum number of apps per collection" - }, - "maxUsersPerService": { - "type": "integer", - "format": "int32", - "description": "The maximum number of users per collection" - }, - "isDesktopEnabled": { - "type": "boolean", - "description": "Whether or not desktops are enabled on this account" - }, - "maxServices": { - "type": "integer", - "format": "int32", - "description": "The maximum number of collections" - }, - "rdWebUrl": { - "type": "string", - "description": "The URL users can go to to access available apps" - }, - "privacyUrl": { - "type": "string", - "description": "Admin-defined URL to the privacy statement" - }, - "accountLocation": { - "type": "string", - "description": "The home location for the account" - }, - "billingState": { - "type": "string", - "description": "The billing state of the account", - "enum": [ - "Trial", - "TrialExpired", - "Active", - "Inactive", - "Preview" - ], - "x-ms-enum": { - "name": "AccountBillingState", - "modelAsString": false - } - }, - "trialEndTime": { - "type": "string", - "format": "date-time", - "description": "Trial end time for the account when in trial billing state" - } - }, - "description": "The details of an account." - }, - "AccountDetailsAll": { - "properties": { - "accountInfo": { - "$ref": "#/definitions/AccountDetails", - "description": "Account properties" - }, - "billingPlans": { - "type": "array", - "items": { - "$ref": "#/definitions/BillingPlan" - }, - "description": "Available billing plans." - }, - "locationList": { - "type": "array", - "items": { - "$ref": "#/definitions/Location" - }, - "description": "List of locations for creating a collection." - } - }, - "description": "A wrapper for account details to be used as a parameter and a response." - }, - "AccountDetailsWrapper": { - "properties": { - "properties": { - "$ref": "#/definitions/AccountDetailsAll", - "description": "Account properties" - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "A wrapper for account details to be used as a parameter" - }, - "AccountDetailsWrapperList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AccountDetailsWrapper" - }, - "description": "Account properties" - } - }, - "description": "A wrapper for account details to be used as a response." - }, - "BillingDate": { - "properties": { - "month": { - "type": "string", - "description": "The billing month" - }, - "year": { - "type": "string", - "description": "The billing year" - } - }, - "description": "The input to get usage details." - }, - "BillingPlan": { - "properties": { - "planId": { - "type": "string", - "description": "Unique identifier of billing plan." - }, - "planName": { - "type": "string", - "description": "Short name of billing plan." - }, - "addOns": { - "type": "string", - "description": "Associated add-ons." - }, - "specCode": { - "type": "string", - "description": "Unique portal plan identifier" - }, - "specString1": { - "type": "string", - "description": "Some information displayed about the plan for portal use" - }, - "specString2": { - "type": "string", - "description": "Some information displayed about the plan for portal use" - }, - "coresPerUser": { - "type": "number", - "format": "double", - "description": "Computing cores per user." - }, - "minimumBilledUserCount": { - "type": "integer", - "format": "int32", - "description": "Minimum number of user to bill." - }, - "billingMeters": { - "type": "array", - "items": { - "$ref": "#/definitions/BillingMeterInformation" - }, - "description": "List of meters for this billing plan" - } - }, - "description": "Contains details of a billing plan." - }, - "BillingMeterInformation": { - "properties": { - "geo": { - "type": "string", - "description": "geo for the billing meter" - }, - "flatMeterId": { - "type": "string", - "description": "The MINT ID for the flat rate" - }, - "overageMeterId": { - "type": "string", - "description": "The MINT ID for the overage rate" - }, - "flatMeterKey": { - "type": "string", - "description": "Key for the flat meter for the billing system" - }, - "overageMeterKey": { - "type": "string", - "description": "Key for the flat meter for the billing system" - } - } - }, - "Location": { - "properties": { - "locationName": { - "type": "string", - "description": "The name of the location" - }, - "displayName": { - "type": "string", - "description": "The display name of the location" - } - }, - "description": "The location a resource can be in." - }, - "ActiveDirectoryConfig": { - "properties": { - "DomainName": { - "type": "string", - "description": "The name of the on-premise domain to join the RD Session Host servers to." - }, - "OrganizationalUnit": { - "type": "string", - "description": "The name of your domain's organizational unit to assign the RD Session Host servers to, e.g. OU=MyOu,DC=MyDomain,DC=ParentDomain,DC=com. Attributes such as OU, DC, etc. must be in uppercase." - }, - "ServiceAccountUserName": { - "type": "string", - "description": "The user name of a service account that has permission to add computers to the domain. The username must be specified in the UPN or down-level logon name format (user@some.domain or some.domain\\user)." - }, - "ServiceAccountPassword": { - "type": "string", - "description": "The service account's password." - } - }, - "description": "Details of a RemoteApp active directory configuration." - }, - "ApplicationDetails": { - "properties": { - "displayName": { - "type": "string", - "description": "The application's display name." - }, - "virtualPath": { - "type": "string", - "description": "Path to the application. The path should reference default operating system environment variables such as %ProgramFiles%, %ProgramFiles(x86)%, %SystemRoot%, etc. where possible. For example, use '%SystemRoot%\\notepad.exe' rather than 'C:\\Windows\\notepad.exe'." - }, - "applicationAlias": { - "type": "string", - "description": "A short unique name for the application." - }, - "availableToUsers": { - "type": "boolean", - "description": "A flag to denote if the application will be available to end users." - }, - "commandLineArguments": { - "type": "string", - "description": "Optional command-line arguments to pass to the application." - }, - "iconUri": { - "type": "string", - "description": "The URI for the application's default icon PNG file." - }, - "status": { - "type": "string", - "description": "The application status.", - "enum": [ - "Publishing", - "Published", - "Unpublishing", - "Modifying", - "Invalid" - ], - "x-ms-enum": { - "name": "AppPublishingStatus", - "modelAsString": false - } - }, - "iconPngUris": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The available map of icon PNG file URIs for different resolutions (e.g. 16x16, 32x32, 64x64). The key of the map is the first dimension of the PNG resolution." - } - }, - "description": "The application details." - }, - "ApplicationDetailsList": { - "properties": { - "DetailsList": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationDetails" - }, - "description": "List of publishing details for remote applications." - } - }, - "description": "List of application details used to create or update a collection." - }, - "CollectionMetricsDetailsWrapper": { - "properties": { - "properties": { - "$ref": "#/definitions/CollectionMetricsDetails", - "description": "Collection usage summary information." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Details of collection metrics." - }, - "CollectionMetricsDetails": { - "properties": { - "overageHours": { - "$ref": "#/definitions/CollectionMetrics", - "description": "Number of overage hours incurred" - }, - "billedUsers": { - "$ref": "#/definitions/CollectionMetrics", - "description": "Number of users billed" - } - } - }, - "CollectionMetrics": { - "properties": { - "aggregationMinutes": { - "type": "integer", - "format": "int32", - "description": "Number of minutes over which the metric is aggregated" - }, - "values": { - "type": "array", - "items": { - "$ref": "#/definitions/CollectionMetric" - }, - "description": "Values of metric" - } - } - }, - "CollectionMetric": { - "properties": { - "timeCreated": { - "type": "string", - "format": "date-time", - "description": "Time when the metric value sample was taken" - }, - "total": { - "type": "number", - "format": "double", - "description": "Total number of metric values over the aggregation period" - }, - "minimum": { - "type": "number", - "format": "double", - "description": "Minimum value of the metric over the aggregation period" - }, - "maximum": { - "type": "number", - "format": "double", - "description": "Maximum value of the metric over the aggregation period" - }, - "count": { - "type": "integer", - "format": "int32", - "description": "Number of samples taken over the aggregation period" - } - } - }, - "CollectionCreationDetails": { - "properties": { - "collectionName": { - "type": "string", - "description": "The collection's name" - }, - "description": { - "type": "string", - "description": "A description for the collection" - }, - "templateImageName": { - "type": "string", - "description": "The name of the template image for the collection" - }, - "sourceImageSasUri": { - "type": "string", - "description": "SAS URI for an OS image in the VM library" - }, - "vnetName": { - "type": "string", - "description": "The name of the Vnet for the collection" - }, - "virtualNetworkId": { - "type": "string", - "description": "The ID of the Vnet for the collection" - }, - "adInfo": { - "$ref": "#/definitions/ActiveDirectoryConfig", - "description": "The account subscriptionId" - }, - "billingPlanName": { - "type": "string", - "description": "The plan name associated with this collection." - }, - "customRdpProperty": { - "type": "string", - "description": "Optional customer-defined RDP properties of the collection." - }, - "readyForPublishing": { - "type": "boolean", - "description": "A flag denoting if this collection is ready for publishing operations." - }, - "mode": { - "type": "string", - "description": "The collection mode.", - "enum": [ - "Unassigned", - "Apps", - "Desktop" - ], - "x-ms-enum": { - "name": "CollectionMode", - "modelAsString": false - } - }, - "waitBeforeShutdownInMinutes": { - "type": "integer", - "format": "int32", - "description": "The amount of time to wait, in minutes, before forcing logoff." - }, - "collectionLocation": { - "type": "string", - "description": "The home location for the account" - }, - "publishedApplications": { - "$ref": "#/definitions/ApplicationDetailsList", - "description": "A list of details of the published applications" - }, - "allowedPrincipals": { - "$ref": "#/definitions/SecurityPrincipalList", - "description": "A list of allowed security principals" - }, - "DnsServers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of the DNS Servers." - }, - "subnetName": { - "type": "string", - "description": "The subnet name of the customer created Azure VNet." - }, - "notDomainJoined": { - "type": "boolean", - "description": "True if the collection is domain joined, false otherwise" - }, - "resourceGroupName": { - "type": "string", - "description": "The name of the resource group the collection is in" - } - }, - "description": "The details for creating a collection." - }, - "CollectionCreationDetailsWrapper": { - "properties": { - "properties": { - "$ref": "#/definitions/CollectionCreationDetails", - "description": "Collection creation properties." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Details of collection creation operation results." - }, - "CollectionUsageSummaryProperties": { - "properties": { - "userName": { - "type": "string", - "description": "The user's UPN." - }, - "includedUsage": { - "type": "number", - "format": "double", - "description": "The number of hours used which are included in the billing plan's base rate." - }, - "overageUsage": { - "type": "number", - "format": "double", - "description": "The number of hours used beyond the billing plan's included usage, but not exceeding the billing plan's maximum cost." - }, - "waivedUsage": { - "type": "number", - "format": "double", - "description": "The number of hours used beyond the billing plan's maximum cost. These usage hours are not billed." - }, - "totalUsage": { - "type": "number", - "format": "double", - "description": "The total usage hours by the user." - } - }, - "description": "The collection usage billing summary." - }, - "CollectionUsageSummaryListItemProperties": { - "properties": { - "userName": { - "type": "string", - "description": "The user's UPN." - }, - "includedUsage": { - "type": "number", - "format": "double", - "description": "The number of hours used which are included in the billing plan's base rate." - }, - "overageUsage": { - "type": "number", - "format": "double", - "description": "The number of hours used beyond the billing plan's included usage, but not exceeding the billing plan's maximum cost." - }, - "waivedUsage": { - "type": "number", - "format": "double", - "description": "The number of hours used beyond the billing plan's maximum cost. These usage hours are not billed." - }, - "totalUsage": { - "type": "number", - "format": "double", - "description": "The total usage hours by the user." - } - }, - "description": "The collection usage billing summary." - }, - "CollectionUsageSummary": { - "properties": { - "properties": { - "$ref": "#/definitions/CollectionUsageSummaryProperties", - "description": "Collection usage summary information." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Details of usage summary operation results." - }, - "CollectionUsageSummaryList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/CollectionUsageSummary" - }, - "description": "A list of usage summary details" - } - }, - "description": "A list of usage summary details" - }, - "CollectionProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "The collection provisioning state.", - "enum": [ - "Cancelled", - "Creating", - "Deprovisioning", - "Disabling", - "Disabled", - "Enabling", - "Failed", - "InProgress", - "Provisioning", - "Succeeded", - "Upgrading" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "collectionName": { - "type": "string", - "description": "The collection name." - }, - "description": { - "type": "string", - "description": "The description of the collection." - }, - "templateImageName": { - "type": "string", - "description": "The name of the template image associated with this collection." - }, - "status": { - "type": "string", - "description": "The collection status." - }, - "lastErrorCode": { - "type": "string", - "description": "The last operation error code on this collection." - }, - "virtualNetworkId": { - "type": "string", - "description": "The ID of the Vnet for this collection." - }, - "vnetName": { - "type": "string", - "description": "The VNet name associated with this collection." - }, - "adInfo": { - "$ref": "#/definitions/ActiveDirectoryConfig", - "description": "The domain join details for this collection." - }, - "billingPlanName": { - "type": "string", - "description": "The plan name associated with this collection." - }, - "customRdpProperty": { - "type": "string", - "description": "Optional customer-defined RDP properties of the collection." - }, - "readyForPublishing": { - "type": "boolean", - "description": "A flag denoting if this collection is ready for publishing operations." - }, - "lastModifiedTimeUtc": { - "type": "string", - "format": "date-time", - "description": "UTC date and time of the last modification of this collection." - }, - "mode": { - "type": "string", - "description": "The collection mode.", - "enum": [ - "Unassigned", - "Apps", - "Desktop" - ], - "x-ms-enum": { - "name": "CollectionMode", - "modelAsString": false - } - }, - "maxSessions": { - "type": "integer", - "format": "int32", - "description": "The maximum number of concurrent users allowed for this collection." - }, - "sessionWarningThreshold": { - "type": "integer", - "format": "int32", - "description": "The end-user session limit warning threshold. Reaching or crossing this threshold will cause a capacity warning message to be shown in the management portal." - }, - "collectionType": { - "type": "string", - "description": "The type of the collection", - "enum": [ - "Hybrid", - "CloudOnly", - "HybridWithoutDomain" - ], - "x-ms-enum": { - "name": "RemoteAppCollectionType", - "modelAsString": false - } - }, - "officeType": { - "type": "string", - "description": "If the template image for this collection includes Office this will specify the type.", - "enum": [ - "None", - "OfficeSAL", - "Office365", - "Unknown" - ], - "x-ms-enum": { - "name": "OfficeType", - "modelAsString": false - } - }, - "trialOnly": { - "type": "boolean", - "description": "Trial-only collections can be used only during the trial period of your subscription. When the trial expires or you activate your subscription, these collections will be permanently disabled." - }, - "DnsServers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of the DNS Servers." - }, - "subnetName": { - "type": "string", - "description": "The subnet name of the customer created Azure VNet." - }, - "healthStatus": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of collection health status messages" - }, - "diagnosticOperations": { - "type": "array", - "items": { - "$ref": "#/definitions/DiagnosticOp" - }, - "description": "List of diagnostics operations for the collection." - }, - "diagnosticDetails": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Details of diagnostics for the collection. Each entry in this list is in the form of Key#Value." - } - }, - "description": "The collection details." - }, - "DiagnosticOp": { - "properties": { - "id": { - "type": "string", - "description": "Id of diagnostic operation." - }, - "result": { - "type": "string", - "description": "Result of diagnostic operation. Zero indicates success; other values indicate errors." - } - }, - "description": "The application security principal details." - }, - "Collection": { - "properties": { - "properties": { - "$ref": "#/definitions/CollectionProperties", - "description": "Collection properties." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "The response for the get collection operation." - }, - "CollectionListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Collection" - }, - "description": "A list of collection details" - }, - "nextLink": { - "type": "string", - "description": "URL to use for request paging." - } - }, - "description": "A list of collection details" - }, - "OperationDisplayInfo": { - "properties": { - "provider": { - "type": "string", - "description": "The name of the resource provider" - }, - "resource": { - "type": "string", - "description": "The name of the related resource" - }, - "operation": { - "type": "string", - "description": "The name of the operation" - }, - "description": { - "type": "string", - "description": "A description of the resource" - } - }, - "description": "Display information about an operation" - }, - "OperationInfo": { - "properties": { - "name": { - "type": "string", - "description": "The name of the operation being performed on this particular object." - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "Display information about the operation" - }, - "origin": { - "type": "string", - "description": "The intended executor of the operation." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "description": "Information about a particular operation." - }, - "OperationInfoList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/OperationInfo" - }, - "description": "A list of operation details" - }, - "nextLink": { - "type": "string", - "description": "URL to use for request paging." - } - }, - "description": "A list of operation details" - }, - "PublishedApplicationDetails": { - "properties": { - "properties": { - "$ref": "#/definitions/ApplicationDetails", - "description": "PublishedApplication properties." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Publishing details of remote application." - }, - "PublishedApplicationDetailsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PublishedApplicationDetails" - }, - "description": "PublishedApplication properties." - } - }, - "description": "Publishing details of remote application." - }, - "StartMenuApplicationProperties": { - "properties": { - "commandLineArguments": { - "type": "string", - "description": "The command line arguments to launch the application." - }, - "iconPngUris": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The available map of icon PNG file URIs for different resolutions (e.g. 16x16, 32x32, 64x64). The key of the map is the first dimension of the PNG resolution." - }, - "iconUri": { - "type": "string", - "description": "The default URI to the application icon png file." - }, - "startMenuApplicationName": { - "type": "string", - "description": "The application name." - }, - "startMenuApplicationId": { - "type": "string", - "description": "The start menu application id." - }, - "virtualPath": { - "type": "string", - "description": "The application image path on the destination machine specified with environment variables for the drive and known system path." - } - }, - "description": "The StartMenuApplication details." - }, - "StartMenuApplication": { - "properties": { - "properties": { - "$ref": "#/definitions/StartMenuApplicationProperties", - "description": "StartMenuApplication properties." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Definition containing details of Start Menu applications." - }, - "StartMenuApplicationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/StartMenuApplication" - }, - "description": "StartMenuApplication properties." - } - }, - "description": "Definition containing details of Start Menu applications." - }, - "PublishingDetails": { - "properties": { - "applicationAlias": { - "type": "string", - "description": "The application alias." - }, - "applicationVirtualPath": { - "type": "string", - "description": "The application virtual path with respect to local machine." - }, - "success": { - "type": "boolean", - "description": "Whether operation was successful." - }, - "errorMessage": { - "type": "string", - "description": "Error message with respect to operation result." - } - }, - "description": "Result of the operation" - }, - "PublishingOperationResult": { - "properties": { - "properties": { - "$ref": "#/definitions/PublishingDetails", - "description": "PublishingOperation properties." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Details of publishing / unpublishing operation results." - }, - "SecurityPrincipal": { - "properties": { - "securityPrincipalType": { - "type": "string", - "description": "The security principal type.", - "enum": [ - "User", - "Group" - ], - "x-ms-enum": { - "name": "PrincipalType", - "modelAsString": false - } - }, - "userIdType": { - "type": "string", - "description": "The security principal provider type.", - "enum": [ - "OrgId", - "MicrosoftAccount" - ], - "x-ms-enum": { - "name": "PrincipalProviderType", - "modelAsString": false - } - }, - "upn": { - "type": "string", - "description": "The security principal UPN." - }, - "aadObjectId": { - "type": "string", - "description": "For OrgId principals, the principal's Azure ActiveDirectory object ID" - }, - "description": { - "type": "string", - "description": "The security principal description." - } - }, - "description": "The application security principal details." - }, - "SecurityPrincipalList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityPrincipalInfo" - } - } - }, - "description": "The list of security principals." - }, - "SecurityPrincipalInfoProperties": { - "properties": { - "status": { - "type": "string", - "description": "The user consent status.", - "enum": [ - "Unknown", - "NotFound", - "Pending", - "Accepted", - "Rejected", - "Ignored" - ], - "x-ms-enum": { - "name": "ConsentStatus", - "modelAsString": false - } - }, - "user": { - "$ref": "#/definitions/SecurityPrincipal", - "description": "The security principal information." - } - }, - "description": "Contains a security principal and that principal's consent status for this collection." - }, - "SecurityPrincipalInfo": { - "properties": { - "properties": { - "$ref": "#/definitions/SecurityPrincipalInfoProperties", - "description": "SecurityPrincipalInfo properties." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Contains details about the security principal and that principal's consent status for this collection." - }, - "SessionProperties": { - "properties": { - "logonTimeUtc": { - "type": "string", - "format": "date-time", - "description": "The UTC time the session started" - }, - "userUpn": { - "type": "string", - "description": "The Upn of the currently active user" - }, - "state": { - "type": "string", - "description": "The session state. Possible values are 'Active', 'Disconnected', 'NoSession', 'Unknown'", - "enum": [ - "Active", - "Connected", - "Disconnected", - "NoSession", - "Unknown" - ], - "x-ms-enum": { - "name": "SessionState", - "modelAsString": false - } - } - }, - "description": "The details of a session." - }, - "Session": { - "properties": { - "properties": { - "$ref": "#/definitions/SessionProperties", - "description": "A RemoteApp session" - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "The wrapper for the session object" - }, - "SessionList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Session" - }, - "description": "A list of sessions" - } - }, - "description": "The response for the get session list operation." - }, - "SessionSendMessageCommandParameter": { - "properties": { - "message": { - "type": "string", - "description": "Message to send to the specified user." - } - }, - "description": "Parameter definition for session commands." - }, - "SecurityPrincipalListParameter": { - "properties": { - "SecurityPrincipals": { - "type": "array", - "items": { - "$ref": "#/definitions/SecurityPrincipal" - }, - "description": "The list of security principals." - } - }, - "description": "The list of security principals." - }, - "SecurityPrincipalErrorDetails": { - "properties": { - "securityPrincipal": { - "type": "string", - "description": "The security principal name." - }, - "error": { - "type": "string", - "description": "The security principal operation result error code, if any.", - "enum": [ - "CouldNotBeResolved", - "NotFound", - "AlreadyExists", - "NotSupported", - "NotDirsynced", - "AssignedToAnotherCollection" - ], - "x-ms-enum": { - "name": "SecurityPrincipalOperationError", - "modelAsString": false - } - }, - "errorDetails": { - "type": "string", - "description": "Additional details about the error code, if available." - } - }, - "description": "The security principal which failed this operation and the error." - }, - "SecurityPrincipalOperationErrorDetails": { - "properties": { - "properties": { - "$ref": "#/definitions/SecurityPrincipalErrorDetails", - "description": "Security principal error details properties." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Operational results of adding or removing a security principal." - }, - "TemplateImageProperties": { - "properties": { - "templateImageName": { - "type": "string", - "description": "The friendly name for the image" - }, - "size": { - "type": "integer", - "format": "int64", - "description": "The image size in bytes" - }, - "status": { - "type": "string", - "description": "The status of the template image", - "enum": [ - "UploadPending", - "UploadInProgress", - "UploadComplete", - "UploadFailed", - "ImportInProgress", - "ImportFailed", - "ImportComplete", - "ValidationFailed", - "Ready", - "Corrupted", - "Deleting" - ], - "x-ms-enum": { - "name": "TemplateImageStatus", - "modelAsString": false - } - }, - "locationList": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of locations where the image can be used" - }, - "templateImageType": { - "type": "string", - "description": "The type of the template image.", - "enum": [ - "CustomerImage", - "MicrosoftImage", - "Unknown" - ], - "x-ms-enum": { - "name": "TemplateImageType", - "modelAsString": false - } - }, - "trialOnly": { - "type": "boolean", - "description": "A TrialOnly platform template image may be used only during a subscription's RemoteApp trial period. Once billing is activated, a collection using a TrialOnly template image will be permanently disabled." - }, - "officeType": { - "type": "string", - "description": "If the template image for this collection includes Office this will specify the type.", - "enum": [ - "None", - "OfficeSAL", - "Office365", - "Unknown" - ], - "x-ms-enum": { - "name": "OfficeType", - "modelAsString": false - } - }, - "numberOfLinkedCollections": { - "type": "integer", - "format": "int64", - "description": "The number of collections linked to the template image." - }, - "uploadCompleteTime": { - "type": "string", - "format": "date-time", - "description": "The time when the template image upload was completed." - } - }, - "description": "Details of a template image" - }, - "TemplateImage": { - "properties": { - "properties": { - "$ref": "#/definitions/TemplateImageProperties", - "description": "A template image" - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "The wrapper for the template image object" - }, - "TemplateImageList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TemplateImage" - }, - "description": "A list of template images" - } - }, - "description": "The response for the get template images operation." - }, - "UsageDetailsInfo": { - "properties": { - "extraData": { - "type": "string", - "description": "URI for the CSV file" - }, - "resultId": { - "type": "string", - "description": "ID of the CSV file creation operation" - } - }, - "description": "URI information about the usage details CSV file" - }, - "VmDetailProperties": { - "properties": { - "virtualMachineName": { - "type": "string", - "description": "The virtual machine name." - }, - "loggedOnUserUpn": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of the users logged onto this virtual machine." - } - }, - "description": "The virtual machine details." - }, - "VmDetails": { - "properties": { - "properties": { - "$ref": "#/definitions/VmDetailProperties", - "description": "VmDetails properties." - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "The response for the get virtual machine operation." - }, - "VirtualMachineDetailsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VmDetails" - }, - "description": "A list of virtual machine details" - }, - "nextLink": { - "type": "string", - "description": "URL to use for request paging." - } - }, - "description": "A list of virtual machine details" - }, - "VmCommandDetailsWrapper": { - "properties": { - "properties": { - "$ref": "#/definitions/VmCommandDetailsAll", - "description": "Virtual machine properties" - }, - "etag": { - "type": "string", - "description": "The etag of the resource." - }, - "nextLink": { - "type": "string", - "description": "The URL for requesting next page of resources." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "A wrapper for virtual machine command details to be used as a parameter" - }, - "VmCommandDetailsAll": { - "properties": { - "logoffMessage": { - "type": "string", - "description": "Message to display to the user." - }, - "logoffWaitTimeInSeconds": { - "type": "integer", - "description": "Time to wait before restarting the virtual machine." - } - }, - "description": "The virtual machine details." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": true - } - }, - "parameters": { - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "A Microsoft Azure subscription ID." - }, - "armNamespace": { - "name": "armNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Azure Resource Manager namespace for RemoteApp service environments." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "RemoteAppManagementClient", + "version": "2014-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/{armNamespace}/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_GetAvailable", + "description": "Gets the available RemoteApp operations", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/OperationInfoList" + } + }, + "202": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{armNamespace}/accounts/{subscriptionId}": { + "get": { + "tags": [ + "Account" + ], + "operationId": "Account_Get", + "description": "Gets the account associated with the subscription id.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AccountDetailsWrapperList" + } + }, + "202": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{armNamespace}/accounts/{subscriptionId}/activateBilling": { + "post": { + "tags": [ + "Account" + ], + "operationId": "Account_ActivateBilling", + "description": "Activates billing for the account", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{armNamespace}/accounts/{subscriptionId}/update": { + "post": { + "tags": [ + "Account" + ], + "operationId": "Account_Update", + "description": "Updates the account PrivacyUrl and WorkspaceName.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "accountInfo", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountDetailsWrapper" + }, + "description": "The new PrivacyUrl and WorkspaceName" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AccountDetailsWrapperList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{armNamespace}/templateImages": { + "get": { + "tags": [ + "TemplateImages" + ], + "operationId": "TemplateImage_List", + "description": "Gets available template images in the specified location", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TemplateImageList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/{armNamespace}/templateImages/{templateImageName}": { + "get": { + "tags": [ + "TemplateImages" + ], + "operationId": "TemplateImage_Get", + "description": "Gets a template image.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TemplateImage" + } + } + } + }, + "parameters": [ + { + "name": "templateImageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the template image" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_ListInResourceGroup", + "description": "Gets the list of collections details in the resource group.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CollectionListResult" + } + }, + "202": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/providers/{armNamespace}/collections": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_ListInSubscription", + "description": "Gets the list of collections details in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CollectionListResult" + } + }, + "202": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_Get", + "description": "Gets the collection details.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Collection" + } + }, + "202": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Collection" + ], + "operationId": "Collection_CreateOrUpdate", + "description": "Create or update a collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "details", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CollectionCreationDetailsWrapper" + }, + "description": "The details of the created or updated collection" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CollectionCreationDetailsWrapper" + } + } + } + }, + "delete": { + "tags": [ + "Collection" + ], + "operationId": "Collection_Delete", + "description": "Delete the collection", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "" + }, + "202": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/applications": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_ListPublishedApps", + "description": "Gets the list of published applications in this collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PublishedApplicationDetailsListResult" + } + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/applications/{alias}": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetPublishedApp", + "description": "Gets the specified published application in this collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PublishedApplicationDetails" + } + }, + "202": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Collection" + ], + "operationId": "Collection_PublishOrUpdateApplication", + "description": "Publishes a new application or updates a previously published application.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "applicationDetails", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationDetails" + }, + "description": "Details of the applicaton to publish or modify" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PublishingOperationResult" + } + }, + "202": { + "description": "" + } + } + }, + "delete": { + "tags": [ + "Collection" + ], + "operationId": "Collection_Unpublish", + "description": "Unpublishes published application matching the application alias (short unique name) from the collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PublishingOperationResult" + } + }, + "202": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "alias", + "in": "path", + "required": true, + "type": "string", + "description": "The alias for the application." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_ListSessions", + "description": "Gets a list of sessions on the current collection", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SessionList" + } + }, + "202": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions/{userUpn}": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetSession", + "description": "Gets the specified user's session on the current collection", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Session" + } + }, + "202": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "userUpn", + "in": "path", + "required": true, + "type": "string", + "description": "The UPN of the user" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions/{userUpn}/disconnect": { + "post": { + "tags": [ + "Collection" + ], + "operationId": "Collection_SessionDisconnect", + "description": "Disconnects the specified user", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "" + }, + "202": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "userUpn", + "in": "path", + "required": true, + "type": "string", + "description": "The UPN of the user" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions/{userUpn}/logoff": { + "post": { + "tags": [ + "Collection" + ], + "operationId": "Collection_SessionLogOff", + "description": "Logs off the specified user", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "userUpn", + "in": "path", + "required": true, + "type": "string", + "description": "The UPN of the user" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/sessions/{userUpn}/sendMessage": { + "post": { + "tags": [ + "Collection" + ], + "operationId": "Collection_SessionSendMessage", + "description": "Sends a message to the specified user", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "messageDetails", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionSendMessageCommandParameter" + }, + "description": "Session message details" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "userUpn", + "in": "path", + "required": true, + "type": "string", + "description": "The UPN of the user" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/startMenuApps": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_ListStartMenuApps", + "description": "Gets the list of applications available in this collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StartMenuApplicationListResult" + } + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/startMenuApps/{applicationId}": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetStartMenuApp", + "description": "Gets the specified Start Menu application available in this collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "name": "applicationId", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the application." + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StartMenuApplication" + } + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/usageDetails": { + "post": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetUsageDetails", + "description": "Generates a CSV file of collection usage details and returns the URI", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/UsageDetailsInfo" + } + }, + "202": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + }, + { + "name": "date", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BillingDate" + }, + "description": "The year and month to get billing for" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/usageSummaries": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetUsageSummaryList", + "description": "Gets a summary of usage data for all users in the collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "name": "usageMonth", + "in": "query", + "required": true, + "type": "string", + "description": "The requested month for collection usage information" + }, + { + "name": "usageYear", + "in": "query", + "required": true, + "type": "string", + "description": "The requested year for collection usage information" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CollectionUsageSummaryList" + } + }, + "202": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/usageSummaries/{userUpn}": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetUsageSummary", + "description": "Gets a summary of collection usage data for the specified user.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "name": "usageMonth", + "in": "query", + "required": true, + "type": "string", + "description": "The requested month for collection usage information" + }, + { + "name": "usageYear", + "in": "query", + "required": true, + "type": "string", + "description": "The requested year for collection usage information" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CollectionUsageSummary" + } + }, + "202": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "userUpn", + "in": "path", + "required": true, + "type": "string", + "description": "The UPN of the user" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/metrics": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetMetrics", + "description": "Gets the list of collection metric values for specified time window.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "name": "startTimeUtc", + "in": "query", + "required": false, + "type": "string", + "description": "UTC start time for the time window formatted as 'yyyyMMdd'" + }, + { + "name": "endTimeUtc", + "in": "query", + "required": false, + "type": "string", + "description": "UTC end time for the time window formatted as 'yyyyMMdd'" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CollectionMetricsDetailsWrapper" + } + }, + "202": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/users": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetUsers", + "description": "Gets a list of all RemoteApp users associated with the given collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SecurityPrincipalList" + } + }, + "202": { + "description": "" + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{armNamespace}/collections/{collectionName}/users/{userUpn}": { + "get": { + "tags": [ + "Collection" + ], + "operationId": "Collection_GetUser", + "description": "Gets a RemoteApp user by their UPN.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SecurityPrincipalInfo" + } + }, + "202": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Collection" + ], + "operationId": "Collection_AddUser", + "description": "Adds a user to the given collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "securityPrincipal", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPrincipal" + }, + "description": "A RemoteApp user to add." + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SecurityPrincipalOperationErrorDetails" + } + } + } + }, + "delete": { + "tags": [ + "Collection" + ], + "operationId": "Collection_DeleteUser", + "description": "Deletes a user from the given collection.", + "parameters": [ + { + "$ref": "#/parameters/armNamespace" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "securityPrincipal", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPrincipal" + }, + "description": "The RemoteApp user to remove." + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SecurityPrincipalOperationErrorDetails" + } + } + } + }, + "parameters": [ + { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The collection name." + }, + { + "name": "userUpn", + "in": "path", + "required": true, + "type": "string", + "description": "The UPN of the user" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group" + } + ] + } + }, + "definitions": { + "AccountDetails": { + "properties": { + "accountId": { + "type": "string", + "description": "The account subscriptionId" + }, + "workspaceName": { + "type": "string", + "description": "Name of the workspace" + }, + "maxPublishedAppsPerService": { + "type": "integer", + "format": "int32", + "description": "The maximum number of apps per collection" + }, + "maxUsersPerService": { + "type": "integer", + "format": "int32", + "description": "The maximum number of users per collection" + }, + "isDesktopEnabled": { + "type": "boolean", + "description": "Whether or not desktops are enabled on this account" + }, + "maxServices": { + "type": "integer", + "format": "int32", + "description": "The maximum number of collections" + }, + "rdWebUrl": { + "type": "string", + "description": "The URL users can go to to access available apps" + }, + "privacyUrl": { + "type": "string", + "description": "Admin-defined URL to the privacy statement" + }, + "accountLocation": { + "type": "string", + "description": "The home location for the account" + }, + "billingState": { + "type": "string", + "description": "The billing state of the account", + "enum": [ + "Trial", + "TrialExpired", + "Active", + "Inactive", + "Preview" + ], + "x-ms-enum": { + "name": "AccountBillingState", + "modelAsString": false + } + }, + "trialEndTime": { + "type": "string", + "format": "date-time", + "description": "Trial end time for the account when in trial billing state" + } + }, + "description": "The details of an account." + }, + "AccountDetailsAll": { + "properties": { + "accountInfo": { + "$ref": "#/definitions/AccountDetails", + "description": "Account properties" + }, + "billingPlans": { + "type": "array", + "items": { + "$ref": "#/definitions/BillingPlan" + }, + "description": "Available billing plans." + }, + "locationList": { + "type": "array", + "items": { + "$ref": "#/definitions/Location" + }, + "description": "List of locations for creating a collection." + } + }, + "description": "A wrapper for account details to be used as a parameter and a response." + }, + "AccountDetailsWrapper": { + "properties": { + "properties": { + "$ref": "#/definitions/AccountDetailsAll", + "description": "Account properties" + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "A wrapper for account details to be used as a parameter" + }, + "AccountDetailsWrapperList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountDetailsWrapper" + }, + "description": "Account properties" + } + }, + "description": "A wrapper for account details to be used as a response." + }, + "BillingDate": { + "properties": { + "month": { + "type": "string", + "description": "The billing month" + }, + "year": { + "type": "string", + "description": "The billing year" + } + }, + "description": "The input to get usage details." + }, + "BillingPlan": { + "properties": { + "planId": { + "type": "string", + "description": "Unique identifier of billing plan." + }, + "planName": { + "type": "string", + "description": "Short name of billing plan." + }, + "addOns": { + "type": "string", + "description": "Associated add-ons." + }, + "specCode": { + "type": "string", + "description": "Unique portal plan identifier" + }, + "specString1": { + "type": "string", + "description": "Some information displayed about the plan for portal use" + }, + "specString2": { + "type": "string", + "description": "Some information displayed about the plan for portal use" + }, + "coresPerUser": { + "type": "number", + "format": "double", + "description": "Computing cores per user." + }, + "minimumBilledUserCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of user to bill." + }, + "billingMeters": { + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeterInformation" + }, + "description": "List of meters for this billing plan" + } + }, + "description": "Contains details of a billing plan." + }, + "BillingMeterInformation": { + "properties": { + "geo": { + "type": "string", + "description": "geo for the billing meter" + }, + "flatMeterId": { + "type": "string", + "description": "The MINT ID for the flat rate" + }, + "overageMeterId": { + "type": "string", + "description": "The MINT ID for the overage rate" + }, + "flatMeterKey": { + "type": "string", + "description": "Key for the flat meter for the billing system" + }, + "overageMeterKey": { + "type": "string", + "description": "Key for the flat meter for the billing system" + } + } + }, + "Location": { + "properties": { + "locationName": { + "type": "string", + "description": "The name of the location" + }, + "displayName": { + "type": "string", + "description": "The display name of the location" + } + }, + "description": "The location a resource can be in." + }, + "ActiveDirectoryConfig": { + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the on-premise domain to join the RD Session Host servers to." + }, + "OrganizationalUnit": { + "type": "string", + "description": "The name of your domain's organizational unit to assign the RD Session Host servers to, e.g. OU=MyOu,DC=MyDomain,DC=ParentDomain,DC=com. Attributes such as OU, DC, etc. must be in uppercase." + }, + "ServiceAccountUserName": { + "type": "string", + "description": "The user name of a service account that has permission to add computers to the domain. The username must be specified in the UPN or down-level logon name format (user@some.domain or some.domain\\user)." + }, + "ServiceAccountPassword": { + "type": "string", + "description": "The service account's password." + } + }, + "description": "Details of a RemoteApp active directory configuration." + }, + "ApplicationDetails": { + "properties": { + "displayName": { + "type": "string", + "description": "The application's display name." + }, + "virtualPath": { + "type": "string", + "description": "Path to the application. The path should reference default operating system environment variables such as %ProgramFiles%, %ProgramFiles(x86)%, %SystemRoot%, etc. where possible. For example, use '%SystemRoot%\\notepad.exe' rather than 'C:\\Windows\\notepad.exe'." + }, + "applicationAlias": { + "type": "string", + "description": "A short unique name for the application." + }, + "availableToUsers": { + "type": "boolean", + "description": "A flag to denote if the application will be available to end users." + }, + "commandLineArguments": { + "type": "string", + "description": "Optional command-line arguments to pass to the application." + }, + "iconUri": { + "type": "string", + "description": "The URI for the application's default icon PNG file." + }, + "status": { + "type": "string", + "description": "The application status.", + "enum": [ + "Publishing", + "Published", + "Unpublishing", + "Modifying", + "Invalid" + ], + "x-ms-enum": { + "name": "AppPublishingStatus", + "modelAsString": false + } + }, + "iconPngUris": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The available map of icon PNG file URIs for different resolutions (e.g. 16x16, 32x32, 64x64). The key of the map is the first dimension of the PNG resolution." + } + }, + "description": "The application details." + }, + "ApplicationDetailsList": { + "properties": { + "DetailsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationDetails" + }, + "description": "List of publishing details for remote applications." + } + }, + "description": "List of application details used to create or update a collection." + }, + "CollectionMetricsDetailsWrapper": { + "properties": { + "properties": { + "$ref": "#/definitions/CollectionMetricsDetails", + "description": "Collection usage summary information." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Details of collection metrics." + }, + "CollectionMetricsDetails": { + "properties": { + "overageHours": { + "$ref": "#/definitions/CollectionMetrics", + "description": "Number of overage hours incurred" + }, + "billedUsers": { + "$ref": "#/definitions/CollectionMetrics", + "description": "Number of users billed" + } + } + }, + "CollectionMetrics": { + "properties": { + "aggregationMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes over which the metric is aggregated" + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/CollectionMetric" + }, + "description": "Values of metric" + } + } + }, + "CollectionMetric": { + "properties": { + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Time when the metric value sample was taken" + }, + "total": { + "type": "number", + "format": "double", + "description": "Total number of metric values over the aggregation period" + }, + "minimum": { + "type": "number", + "format": "double", + "description": "Minimum value of the metric over the aggregation period" + }, + "maximum": { + "type": "number", + "format": "double", + "description": "Maximum value of the metric over the aggregation period" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of samples taken over the aggregation period" + } + } + }, + "CollectionCreationDetails": { + "properties": { + "collectionName": { + "type": "string", + "description": "The collection's name" + }, + "description": { + "type": "string", + "description": "A description for the collection" + }, + "templateImageName": { + "type": "string", + "description": "The name of the template image for the collection" + }, + "sourceImageSasUri": { + "type": "string", + "description": "SAS URI for an OS image in the VM library" + }, + "vnetName": { + "type": "string", + "description": "The name of the Vnet for the collection" + }, + "virtualNetworkId": { + "type": "string", + "description": "The ID of the Vnet for the collection" + }, + "adInfo": { + "$ref": "#/definitions/ActiveDirectoryConfig", + "description": "The account subscriptionId" + }, + "billingPlanName": { + "type": "string", + "description": "The plan name associated with this collection." + }, + "customRdpProperty": { + "type": "string", + "description": "Optional customer-defined RDP properties of the collection." + }, + "readyForPublishing": { + "type": "boolean", + "description": "A flag denoting if this collection is ready for publishing operations." + }, + "mode": { + "type": "string", + "description": "The collection mode.", + "enum": [ + "Unassigned", + "Apps", + "Desktop" + ], + "x-ms-enum": { + "name": "CollectionMode", + "modelAsString": false + } + }, + "waitBeforeShutdownInMinutes": { + "type": "integer", + "format": "int32", + "description": "The amount of time to wait, in minutes, before forcing logoff." + }, + "collectionLocation": { + "type": "string", + "description": "The home location for the account" + }, + "publishedApplications": { + "$ref": "#/definitions/ApplicationDetailsList", + "description": "A list of details of the published applications" + }, + "allowedPrincipals": { + "$ref": "#/definitions/SecurityPrincipalList", + "description": "A list of allowed security principals" + }, + "DnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of the DNS Servers." + }, + "subnetName": { + "type": "string", + "description": "The subnet name of the customer created Azure VNet." + }, + "notDomainJoined": { + "type": "boolean", + "description": "True if the collection is domain joined, false otherwise" + }, + "resourceGroupName": { + "type": "string", + "description": "The name of the resource group the collection is in" + } + }, + "description": "The details for creating a collection." + }, + "CollectionCreationDetailsWrapper": { + "properties": { + "properties": { + "$ref": "#/definitions/CollectionCreationDetails", + "description": "Collection creation properties." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Details of collection creation operation results." + }, + "CollectionUsageSummaryProperties": { + "properties": { + "userName": { + "type": "string", + "description": "The user's UPN." + }, + "includedUsage": { + "type": "number", + "format": "double", + "description": "The number of hours used which are included in the billing plan's base rate." + }, + "overageUsage": { + "type": "number", + "format": "double", + "description": "The number of hours used beyond the billing plan's included usage, but not exceeding the billing plan's maximum cost." + }, + "waivedUsage": { + "type": "number", + "format": "double", + "description": "The number of hours used beyond the billing plan's maximum cost. These usage hours are not billed." + }, + "totalUsage": { + "type": "number", + "format": "double", + "description": "The total usage hours by the user." + } + }, + "description": "The collection usage billing summary." + }, + "CollectionUsageSummaryListItemProperties": { + "properties": { + "userName": { + "type": "string", + "description": "The user's UPN." + }, + "includedUsage": { + "type": "number", + "format": "double", + "description": "The number of hours used which are included in the billing plan's base rate." + }, + "overageUsage": { + "type": "number", + "format": "double", + "description": "The number of hours used beyond the billing plan's included usage, but not exceeding the billing plan's maximum cost." + }, + "waivedUsage": { + "type": "number", + "format": "double", + "description": "The number of hours used beyond the billing plan's maximum cost. These usage hours are not billed." + }, + "totalUsage": { + "type": "number", + "format": "double", + "description": "The total usage hours by the user." + } + }, + "description": "The collection usage billing summary." + }, + "CollectionUsageSummary": { + "properties": { + "properties": { + "$ref": "#/definitions/CollectionUsageSummaryProperties", + "description": "Collection usage summary information." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Details of usage summary operation results." + }, + "CollectionUsageSummaryList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CollectionUsageSummary" + }, + "description": "A list of usage summary details" + } + }, + "description": "A list of usage summary details" + }, + "CollectionProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "The collection provisioning state.", + "enum": [ + "Cancelled", + "Creating", + "Deprovisioning", + "Disabling", + "Disabled", + "Enabling", + "Failed", + "InProgress", + "Provisioning", + "Succeeded", + "Upgrading" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "collectionName": { + "type": "string", + "description": "The collection name." + }, + "description": { + "type": "string", + "description": "The description of the collection." + }, + "templateImageName": { + "type": "string", + "description": "The name of the template image associated with this collection." + }, + "status": { + "type": "string", + "description": "The collection status." + }, + "lastErrorCode": { + "type": "string", + "description": "The last operation error code on this collection." + }, + "virtualNetworkId": { + "type": "string", + "description": "The ID of the Vnet for this collection." + }, + "vnetName": { + "type": "string", + "description": "The VNet name associated with this collection." + }, + "adInfo": { + "$ref": "#/definitions/ActiveDirectoryConfig", + "description": "The domain join details for this collection." + }, + "billingPlanName": { + "type": "string", + "description": "The plan name associated with this collection." + }, + "customRdpProperty": { + "type": "string", + "description": "Optional customer-defined RDP properties of the collection." + }, + "readyForPublishing": { + "type": "boolean", + "description": "A flag denoting if this collection is ready for publishing operations." + }, + "lastModifiedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "UTC date and time of the last modification of this collection." + }, + "mode": { + "type": "string", + "description": "The collection mode.", + "enum": [ + "Unassigned", + "Apps", + "Desktop" + ], + "x-ms-enum": { + "name": "CollectionMode", + "modelAsString": false + } + }, + "maxSessions": { + "type": "integer", + "format": "int32", + "description": "The maximum number of concurrent users allowed for this collection." + }, + "sessionWarningThreshold": { + "type": "integer", + "format": "int32", + "description": "The end-user session limit warning threshold. Reaching or crossing this threshold will cause a capacity warning message to be shown in the management portal." + }, + "collectionType": { + "type": "string", + "description": "The type of the collection", + "enum": [ + "Hybrid", + "CloudOnly", + "HybridWithoutDomain" + ], + "x-ms-enum": { + "name": "RemoteAppCollectionType", + "modelAsString": false + } + }, + "officeType": { + "type": "string", + "description": "If the template image for this collection includes Office this will specify the type.", + "enum": [ + "None", + "OfficeSAL", + "Office365", + "Unknown" + ], + "x-ms-enum": { + "name": "OfficeType", + "modelAsString": false + } + }, + "trialOnly": { + "type": "boolean", + "description": "Trial-only collections can be used only during the trial period of your subscription. When the trial expires or you activate your subscription, these collections will be permanently disabled." + }, + "DnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of the DNS Servers." + }, + "subnetName": { + "type": "string", + "description": "The subnet name of the customer created Azure VNet." + }, + "healthStatus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of collection health status messages" + }, + "diagnosticOperations": { + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticOp" + }, + "description": "List of diagnostics operations for the collection." + }, + "diagnosticDetails": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Details of diagnostics for the collection. Each entry in this list is in the form of Key#Value." + } + }, + "description": "The collection details." + }, + "DiagnosticOp": { + "properties": { + "id": { + "type": "string", + "description": "Id of diagnostic operation." + }, + "result": { + "type": "string", + "description": "Result of diagnostic operation. Zero indicates success; other values indicate errors." + } + }, + "description": "The application security principal details." + }, + "Collection": { + "properties": { + "properties": { + "$ref": "#/definitions/CollectionProperties", + "description": "Collection properties." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "The response for the get collection operation." + }, + "CollectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Collection" + }, + "description": "A list of collection details" + }, + "nextLink": { + "type": "string", + "description": "URL to use for request paging." + } + }, + "description": "A list of collection details" + }, + "OperationDisplayInfo": { + "properties": { + "provider": { + "type": "string", + "description": "The name of the resource provider" + }, + "resource": { + "type": "string", + "description": "The name of the related resource" + }, + "operation": { + "type": "string", + "description": "The name of the operation" + }, + "description": { + "type": "string", + "description": "A description of the resource" + } + }, + "description": "Display information about an operation" + }, + "OperationInfo": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation being performed on this particular object." + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "Display information about the operation" + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Information about a particular operation." + }, + "OperationInfoList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OperationInfo" + }, + "description": "A list of operation details" + }, + "nextLink": { + "type": "string", + "description": "URL to use for request paging." + } + }, + "description": "A list of operation details" + }, + "PublishedApplicationDetails": { + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationDetails", + "description": "PublishedApplication properties." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Publishing details of remote application." + }, + "PublishedApplicationDetailsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublishedApplicationDetails" + }, + "description": "PublishedApplication properties." + } + }, + "description": "Publishing details of remote application." + }, + "StartMenuApplicationProperties": { + "properties": { + "commandLineArguments": { + "type": "string", + "description": "The command line arguments to launch the application." + }, + "iconPngUris": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The available map of icon PNG file URIs for different resolutions (e.g. 16x16, 32x32, 64x64). The key of the map is the first dimension of the PNG resolution." + }, + "iconUri": { + "type": "string", + "description": "The default URI to the application icon png file." + }, + "startMenuApplicationName": { + "type": "string", + "description": "The application name." + }, + "startMenuApplicationId": { + "type": "string", + "description": "The start menu application id." + }, + "virtualPath": { + "type": "string", + "description": "The application image path on the destination machine specified with environment variables for the drive and known system path." + } + }, + "description": "The StartMenuApplication details." + }, + "StartMenuApplication": { + "properties": { + "properties": { + "$ref": "#/definitions/StartMenuApplicationProperties", + "description": "StartMenuApplication properties." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Definition containing details of Start Menu applications." + }, + "StartMenuApplicationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StartMenuApplication" + }, + "description": "StartMenuApplication properties." + } + }, + "description": "Definition containing details of Start Menu applications." + }, + "PublishingDetails": { + "properties": { + "applicationAlias": { + "type": "string", + "description": "The application alias." + }, + "applicationVirtualPath": { + "type": "string", + "description": "The application virtual path with respect to local machine." + }, + "success": { + "type": "boolean", + "description": "Whether operation was successful." + }, + "errorMessage": { + "type": "string", + "description": "Error message with respect to operation result." + } + }, + "description": "Result of the operation" + }, + "PublishingOperationResult": { + "properties": { + "properties": { + "$ref": "#/definitions/PublishingDetails", + "description": "PublishingOperation properties." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Details of publishing / unpublishing operation results." + }, + "SecurityPrincipal": { + "properties": { + "securityPrincipalType": { + "type": "string", + "description": "The security principal type.", + "enum": [ + "User", + "Group" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": false + } + }, + "userIdType": { + "type": "string", + "description": "The security principal provider type.", + "enum": [ + "OrgId", + "MicrosoftAccount" + ], + "x-ms-enum": { + "name": "PrincipalProviderType", + "modelAsString": false + } + }, + "upn": { + "type": "string", + "description": "The security principal UPN." + }, + "aadObjectId": { + "type": "string", + "description": "For OrgId principals, the principal's Azure ActiveDirectory object ID" + }, + "description": { + "type": "string", + "description": "The security principal description." + } + }, + "description": "The application security principal details." + }, + "SecurityPrincipalList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPrincipalInfo" + } + } + }, + "description": "The list of security principals." + }, + "SecurityPrincipalInfoProperties": { + "properties": { + "status": { + "type": "string", + "description": "The user consent status.", + "enum": [ + "Unknown", + "NotFound", + "Pending", + "Accepted", + "Rejected", + "Ignored" + ], + "x-ms-enum": { + "name": "ConsentStatus", + "modelAsString": false + } + }, + "user": { + "$ref": "#/definitions/SecurityPrincipal", + "description": "The security principal information." + } + }, + "description": "Contains a security principal and that principal's consent status for this collection." + }, + "SecurityPrincipalInfo": { + "properties": { + "properties": { + "$ref": "#/definitions/SecurityPrincipalInfoProperties", + "description": "SecurityPrincipalInfo properties." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Contains details about the security principal and that principal's consent status for this collection." + }, + "SessionProperties": { + "properties": { + "logonTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The UTC time the session started" + }, + "userUpn": { + "type": "string", + "description": "The Upn of the currently active user" + }, + "state": { + "type": "string", + "description": "The session state. Possible values are 'Active', 'Disconnected', 'NoSession', 'Unknown'", + "enum": [ + "Active", + "Connected", + "Disconnected", + "NoSession", + "Unknown" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": false + } + } + }, + "description": "The details of a session." + }, + "Session": { + "properties": { + "properties": { + "$ref": "#/definitions/SessionProperties", + "description": "A RemoteApp session" + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "The wrapper for the session object" + }, + "SessionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Session" + }, + "description": "A list of sessions" + } + }, + "description": "The response for the get session list operation." + }, + "SessionSendMessageCommandParameter": { + "properties": { + "message": { + "type": "string", + "description": "Message to send to the specified user." + } + }, + "description": "Parameter definition for session commands." + }, + "SecurityPrincipalListParameter": { + "properties": { + "SecurityPrincipals": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPrincipal" + }, + "description": "The list of security principals." + } + }, + "description": "The list of security principals." + }, + "SecurityPrincipalErrorDetails": { + "properties": { + "securityPrincipal": { + "type": "string", + "description": "The security principal name." + }, + "error": { + "type": "string", + "description": "The security principal operation result error code, if any.", + "enum": [ + "CouldNotBeResolved", + "NotFound", + "AlreadyExists", + "NotSupported", + "NotDirsynced", + "AssignedToAnotherCollection" + ], + "x-ms-enum": { + "name": "SecurityPrincipalOperationError", + "modelAsString": false + } + }, + "errorDetails": { + "type": "string", + "description": "Additional details about the error code, if available." + } + }, + "description": "The security principal which failed this operation and the error." + }, + "SecurityPrincipalOperationErrorDetails": { + "properties": { + "properties": { + "$ref": "#/definitions/SecurityPrincipalErrorDetails", + "description": "Security principal error details properties." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Operational results of adding or removing a security principal." + }, + "TemplateImageProperties": { + "properties": { + "templateImageName": { + "type": "string", + "description": "The friendly name for the image" + }, + "size": { + "type": "integer", + "format": "int64", + "description": "The image size in bytes" + }, + "status": { + "type": "string", + "description": "The status of the template image", + "enum": [ + "UploadPending", + "UploadInProgress", + "UploadComplete", + "UploadFailed", + "ImportInProgress", + "ImportFailed", + "ImportComplete", + "ValidationFailed", + "Ready", + "Corrupted", + "Deleting" + ], + "x-ms-enum": { + "name": "TemplateImageStatus", + "modelAsString": false + } + }, + "locationList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of locations where the image can be used" + }, + "templateImageType": { + "type": "string", + "description": "The type of the template image.", + "enum": [ + "CustomerImage", + "MicrosoftImage", + "Unknown" + ], + "x-ms-enum": { + "name": "TemplateImageType", + "modelAsString": false + } + }, + "trialOnly": { + "type": "boolean", + "description": "A TrialOnly platform template image may be used only during a subscription's RemoteApp trial period. Once billing is activated, a collection using a TrialOnly template image will be permanently disabled." + }, + "officeType": { + "type": "string", + "description": "If the template image for this collection includes Office this will specify the type.", + "enum": [ + "None", + "OfficeSAL", + "Office365", + "Unknown" + ], + "x-ms-enum": { + "name": "OfficeType", + "modelAsString": false + } + }, + "numberOfLinkedCollections": { + "type": "integer", + "format": "int64", + "description": "The number of collections linked to the template image." + }, + "uploadCompleteTime": { + "type": "string", + "format": "date-time", + "description": "The time when the template image upload was completed." + } + }, + "description": "Details of a template image" + }, + "TemplateImage": { + "properties": { + "properties": { + "$ref": "#/definitions/TemplateImageProperties", + "description": "A template image" + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "The wrapper for the template image object" + }, + "TemplateImageList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TemplateImage" + }, + "description": "A list of template images" + } + }, + "description": "The response for the get template images operation." + }, + "UsageDetailsInfo": { + "properties": { + "extraData": { + "type": "string", + "description": "URI for the CSV file" + }, + "resultId": { + "type": "string", + "description": "ID of the CSV file creation operation" + } + }, + "description": "URI information about the usage details CSV file" + }, + "VmDetailProperties": { + "properties": { + "virtualMachineName": { + "type": "string", + "description": "The virtual machine name." + }, + "loggedOnUserUpn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of the users logged onto this virtual machine." + } + }, + "description": "The virtual machine details." + }, + "VmDetails": { + "properties": { + "properties": { + "$ref": "#/definitions/VmDetailProperties", + "description": "VmDetails properties." + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "The response for the get virtual machine operation." + }, + "VirtualMachineDetailsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VmDetails" + }, + "description": "A list of virtual machine details" + }, + "nextLink": { + "type": "string", + "description": "URL to use for request paging." + } + }, + "description": "A list of virtual machine details" + }, + "VmCommandDetailsWrapper": { + "properties": { + "properties": { + "$ref": "#/definitions/VmCommandDetailsAll", + "description": "Virtual machine properties" + }, + "etag": { + "type": "string", + "description": "The etag of the resource." + }, + "nextLink": { + "type": "string", + "description": "The URL for requesting next page of resources." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "A wrapper for virtual machine command details to be used as a parameter" + }, + "VmCommandDetailsAll": { + "properties": { + "logoffMessage": { + "type": "string", + "description": "Message to display to the user." + }, + "logoffWaitTimeInSeconds": { + "type": "integer", + "description": "Time to wait before restarting the virtual machine." + } + }, + "description": "The virtual machine details." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "A Microsoft Azure subscription ID." + }, + "armNamespace": { + "name": "armNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Azure Resource Manager namespace for RemoteApp service environments." + } + } +} diff --git a/arm-resources/features/2015-12-01/swagger/features.json b/arm-resources/features/2015-12-01/swagger/features.json index b87b387ef2f3..b4640e321ec1 100644 --- a/arm-resources/features/2015-12-01/swagger/features.json +++ b/arm-resources/features/2015-12-01/swagger/features.json @@ -1,326 +1,326 @@ -{ - "swagger": "2.0", - "info": { - "title": "FeatureClient", - "version": "2015-12-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Features/features": { - "get": { - "tags": [ - "Features" - ], - "operationId": "Features_ListAll", - "description": "Gets a list of previewed features for all the providers in the current subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FeatureOperationsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features": { - "get": { - "tags": [ - "Features" - ], - "operationId": "Features_List", - "description": "Gets a list of previewed features of a resource provider.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FeatureOperationsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}": { - "get": { - "tags": [ - "Features" - ], - "operationId": "Features_Get", - "description": "Get all features under the subscription.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "name": "featureName", - "in": "path", - "required": true, - "type": "string", - "description": "Previewed feature name in the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FeatureResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}/register": { - "post": { - "tags": [ - "Features" - ], - "operationId": "Features_Register", - "description": "Registers for a previewed feature of a resource provider.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "name": "featureName", - "in": "path", - "required": true, - "type": "string", - "description": "Previewed feature name in the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/FeatureResult" - } - } - } - } - } - }, - "definitions": { - "DeploymentExtendedFilter": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the provisioning state." - } - }, - "description": "Deployment filter." - }, - "GenericResourceFilter": { - "properties": { - "resourceType": { - "type": "string", - "description": "Gets or sets the resource type." - }, - "tagname": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "tagvalue": { - "type": "string", - "description": "Gets or sets the tag value." - } - }, - "description": "Resource filter." - }, - "ResourceGroupFilter": { - "properties": { - "tagName": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "tagValue": { - "type": "string", - "description": "Gets or sets the tag value." - } - }, - "description": "Resource group filter." - }, - "FeatureProperties": { - "properties": { - "state": { - "type": "string", - "description": "Gets or sets the state of the previewed feature." - } - }, - "description": "Previewed feature information." - }, - "FeatureResult": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the name of the feature." - }, - "properties": { - "$ref": "#/definitions/FeatureProperties", - "description": "Gets or sets the properties of the previewed feature." - }, - "id": { - "type": "string", - "description": "Gets or sets the Id of the feature." - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the feature." - } - }, - "description": "Previewed feature information." - }, - "FeatureOperationsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FeatureResult" - }, - "description": "Gets or sets the list of Features." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of previewed features." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": 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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "FeatureClient", + "version": "2015-12-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/features": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_ListAll", + "description": "Gets a list of previewed features for all the providers in the current subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FeatureOperationsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_List", + "description": "Gets a list of previewed features of a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FeatureOperationsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}": { + "get": { + "tags": [ + "Features" + ], + "operationId": "Features_Get", + "description": "Get all features under the subscription.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "name": "featureName", + "in": "path", + "required": true, + "type": "string", + "description": "Previewed feature name in the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FeatureResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Features/providers/{resourceProviderNamespace}/features/{featureName}/register": { + "post": { + "tags": [ + "Features" + ], + "operationId": "Features_Register", + "description": "Registers for a previewed feature of a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "name": "featureName", + "in": "path", + "required": true, + "type": "string", + "description": "Previewed feature name in the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FeatureResult" + } + } + } + } + } + }, + "definitions": { + "DeploymentExtendedFilter": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the provisioning state." + } + }, + "description": "Deployment filter." + }, + "GenericResourceFilter": { + "properties": { + "resourceType": { + "type": "string", + "description": "Gets or sets the resource type." + }, + "tagname": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "tagvalue": { + "type": "string", + "description": "Gets or sets the tag value." + } + }, + "description": "Resource filter." + }, + "ResourceGroupFilter": { + "properties": { + "tagName": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "tagValue": { + "type": "string", + "description": "Gets or sets the tag value." + } + }, + "description": "Resource group filter." + }, + "FeatureProperties": { + "properties": { + "state": { + "type": "string", + "description": "Gets or sets the state of the previewed feature." + } + }, + "description": "Previewed feature information." + }, + "FeatureResult": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the feature." + }, + "properties": { + "$ref": "#/definitions/FeatureProperties", + "description": "Gets or sets the properties of the previewed feature." + }, + "id": { + "type": "string", + "description": "Gets or sets the Id of the feature." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the feature." + } + }, + "description": "Previewed feature information." + }, + "FeatureOperationsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FeatureResult" + }, + "description": "Gets or sets the list of Features." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of previewed features." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": 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." + } + } } \ No newline at end of file diff --git a/arm-resources/locks/2015-01-01/swagger/locks.json b/arm-resources/locks/2015-01-01/swagger/locks.json index b0da3ecf4ec1..6f510038434b 100644 --- a/arm-resources/locks/2015-01-01/swagger/locks.json +++ b/arm-resources/locks/2015-01-01/swagger/locks.json @@ -1,753 +1,753 @@ -{ - "swagger": "2.0", - "info": { - "title": "ManagementLockClient", - "version": "2015-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}": { - "put": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_CreateOrUpdateAtResourceGroupLevel", - "description": "Create or update a management lock at the resource group level.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "lockName", - "in": "path", - "required": true, - "type": "string", - "description": "The lock name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ManagementLockObject" - }, - "description": "The management lock parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}": { - "put": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_CreateOrUpdateAtResourceLevel", - "description": "Create or update a management lock at the resource level or any level below resource.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. ", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "lockName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of lock." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ManagementLockObject" - }, - "description": "Create or update management lock parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - } - } - }, - "delete": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_DeleteAtResourceLevel", - "description": "Deletes the management lock of a resource or any level below resource.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. " - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "lockName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of lock." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "200": { - "description": "" - }, - "202": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}": { - "put": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_CreateOrUpdateAtSubscriptionLevel", - "description": "Create or update a management lock at the subscription level.", - "parameters": [ - { - "name": "lockName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of lock." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ManagementLockObject" - }, - "description": "The management lock parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - } - } - }, - "delete": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_DeleteAtSubscriptionLevel", - "description": "Deletes the management lock of a subscription.", - "parameters": [ - { - "name": "lockName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of lock." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "200": { - "description": "" - }, - "202": { - "description": "" - } - } - }, - "get": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_Get", - "description": "Gets the management lock of a scope.", - "parameters": [ - { - "name": "lockName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the management lock." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - }, - "204": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockObject" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Authorization/locks/{lockName}": { - "delete": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_DeleteAtResourceGroupLevel", - "description": "Deletes the management lock of a resource group.", - "parameters": [ - { - "name": "resourceGroup", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group names." - }, - { - "name": "lockName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of lock." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "200": { - "description": "" - }, - "202": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks": { - "get": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_ListAtResourceGroupLevel", - "description": "Gets all the management locks of a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource group name." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/ManagementLockObject" - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks": { - "get": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_ListAtResourceLevel", - "description": "Gets all the management locks of a resource or any level below resource.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/ManagementLockObject" - } - }, - "/{nextLink}": { - "get": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_ListNext", - "description": "Get a list of management locks at resource level or below.", - "parameters": [ - { - "name": "nextLink", - "in": "path", - "required": true, - "type": "string", - "description": "NextLink from the previous successful call to List operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks": { - "get": { - "tags": [ - "ManagementLocks" - ], - "operationId": "ManagementLocks_ListAtSubscriptionLevel", - "description": "Gets all the management locks of a subscription.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ManagementLockListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/ManagementLockObject" - } - } - }, - "definitions": { - "DeploymentExtendedFilter": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the provisioning state." - } - }, - "description": "Deployment filter." - }, - "GenericResourceFilter": { - "properties": { - "resourceType": { - "type": "string", - "description": "Gets or sets the resource type." - }, - "tagname": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "tagvalue": { - "type": "string", - "description": "Gets or sets the tag value." - } - }, - "description": "Resource filter." - }, - "ResourceGroupFilter": { - "properties": { - "tagName": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "tagValue": { - "type": "string", - "description": "Gets or sets the tag value." - } - }, - "description": "Resource group filter." - }, - "ManagementLockProperties": { - "properties": { - "level": { - "type": "string", - "description": "Gets or sets the lock level of the management lock.", - "enum": [ - "NotSpecified", - "CanNotDelete", - "ReadOnly" - ], - "x-ms-enum": { - "name": "LockLevel", - "modelAsString": true - } - }, - "notes": { - "type": "string", - "description": "Gets or sets the notes of the management lock." - } - }, - "description": "The management lock properties." - }, - "ManagementLockObject": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ManagementLockProperties", - "description": "Gets or sets the properties of the lock." - }, - "id": { - "type": "string", - "description": "Gets or sets the Id of the lock." - }, - "type": { - "type": "string", - "description": "Gets or sets the type of the lock." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the lock." - } - }, - "description": "Management lock information.", - "x-ms-azure-resource": true - }, - "ManagementLockListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ManagementLockObject" - }, - "description": "Gets or sets the list of locks." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of management locks." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": 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." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "ManagementLockClient", + "version": "2015-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks/{lockName}": { + "put": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_CreateOrUpdateAtResourceGroupLevel", + "description": "Create or update a management lock at the resource group level.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "lockName", + "in": "path", + "required": true, + "type": "string", + "description": "The lock name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementLockObject" + }, + "description": "The management lock parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks/{lockName}": { + "put": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_CreateOrUpdateAtResourceLevel", + "description": "Create or update a management lock at the resource level or any level below resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. ", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "lockName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of lock." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementLockObject" + }, + "description": "Create or update management lock parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + } + } + }, + "delete": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_DeleteAtResourceLevel", + "description": "Deletes the management lock of a resource or any level below resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. " + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "lockName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of lock." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "200": { + "description": "" + }, + "202": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks/{lockName}": { + "put": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_CreateOrUpdateAtSubscriptionLevel", + "description": "Create or update a management lock at the subscription level.", + "parameters": [ + { + "name": "lockName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of lock." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementLockObject" + }, + "description": "The management lock parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + } + } + }, + "delete": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_DeleteAtSubscriptionLevel", + "description": "Deletes the management lock of a subscription.", + "parameters": [ + { + "name": "lockName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of lock." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "200": { + "description": "" + }, + "202": { + "description": "" + } + } + }, + "get": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_Get", + "description": "Gets the management lock of a scope.", + "parameters": [ + { + "name": "lockName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the management lock." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + }, + "204": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockObject" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Authorization/locks/{lockName}": { + "delete": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_DeleteAtResourceGroupLevel", + "description": "Deletes the management lock of a resource group.", + "parameters": [ + { + "name": "resourceGroup", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group names." + }, + { + "name": "lockName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of lock." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "200": { + "description": "" + }, + "202": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/locks": { + "get": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_ListAtResourceGroupLevel", + "description": "Gets all the management locks of a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ManagementLockObject" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/locks": { + "get": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_ListAtResourceLevel", + "description": "Gets all the management locks of a resource or any level below resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ManagementLockObject" + } + }, + "/{nextLink}": { + "get": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_ListNext", + "description": "Get a list of management locks at resource level or below.", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "NextLink from the previous successful call to List operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/locks": { + "get": { + "tags": [ + "ManagementLocks" + ], + "operationId": "ManagementLocks_ListAtSubscriptionLevel", + "description": "Gets all the management locks of a subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ManagementLockListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ManagementLockObject" + } + } + }, + "definitions": { + "DeploymentExtendedFilter": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the provisioning state." + } + }, + "description": "Deployment filter." + }, + "GenericResourceFilter": { + "properties": { + "resourceType": { + "type": "string", + "description": "Gets or sets the resource type." + }, + "tagname": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "tagvalue": { + "type": "string", + "description": "Gets or sets the tag value." + } + }, + "description": "Resource filter." + }, + "ResourceGroupFilter": { + "properties": { + "tagName": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "tagValue": { + "type": "string", + "description": "Gets or sets the tag value." + } + }, + "description": "Resource group filter." + }, + "ManagementLockProperties": { + "properties": { + "level": { + "type": "string", + "description": "Gets or sets the lock level of the management lock.", + "enum": [ + "NotSpecified", + "CanNotDelete", + "ReadOnly" + ], + "x-ms-enum": { + "name": "LockLevel", + "modelAsString": true + } + }, + "notes": { + "type": "string", + "description": "Gets or sets the notes of the management lock." + } + }, + "description": "The management lock properties." + }, + "ManagementLockObject": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagementLockProperties", + "description": "Gets or sets the properties of the lock." + }, + "id": { + "type": "string", + "description": "Gets or sets the Id of the lock." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the lock." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the lock." + } + }, + "description": "Management lock information.", + "x-ms-azure-resource": true + }, + "ManagementLockListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagementLockObject" + }, + "description": "Gets or sets the list of locks." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of management locks." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": 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." + } + } +} diff --git a/arm-resources/resources/2015-11-01/swagger/resources.json b/arm-resources/resources/2015-11-01/swagger/resources.json index fa9f522fe896..1a7726a36a34 100644 --- a/arm-resources/resources/2015-11-01/swagger/resources.json +++ b/arm-resources/resources/2015-11-01/swagger/resources.json @@ -1,2818 +1,2818 @@ -{ - "swagger": "2.0", - "info": { - "title": "ResourceManagementClient", - "version": "2015-11-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { - "delete": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Delete", - "description": "Begin deleting deployment.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment to be deleted." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "204": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "head": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_CheckExistence", - "description": "Checks whether deployment exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to check. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_CreateOrUpdate", - "description": "Create a named template deployment using a template.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - }, - "description": "Additional parameters supplied to the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Get", - "description": "Get a deployment.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to get. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { - "post": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Cancel", - "description": "Cancel a currently running template deployment.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { - "post": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Validate", - "description": "Validate a deployment template.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - }, - "description": "Deployment to validate." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentValidateResult" - } - }, - "400": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentValidateResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": { - "get": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_List", - "description": "Get a list of deployments.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to filter by. The name is case insensitive." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all deployments." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/DeploymentExtendedFilter" - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": { - "post": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Unregister", - "description": "Unregisters provider from a subscription.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": { - "post": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Register", - "description": "Registers provider to be used with a subscription.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers": { - "get": { - "tags": [ - "Providers" - ], - "operationId": "Providers_List", - "description": "Gets a list of resource providers.", - "parameters": [ - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all deployments." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ProviderListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": { - "get": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Get", - "description": "Gets a resource provider.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": { - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_ListResources", - "description": "Get all of the resources under a subscription.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/GenericResourceFilter" - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": { - "head": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_CheckExistence", - "description": "Checks whether resource group exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to check. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "put": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_CreateOrUpdate", - "description": "Create a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be created or updated.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Parameters supplied to the create or update resource group service operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - }, - "delete": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_Delete", - "description": "Begin deleting resource group.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be deleted. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_Get", - "description": "Get a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to get. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - }, - "patch": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_Patch", - "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be created or updated. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Parameters supplied to the update state resource group service operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups": { - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_List", - "description": "Gets a collection of resource groups.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroupListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/ResourceGroupFilter" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": { - "post": { - "tags": [ - "Resources" - ], - "operationId": "Resources_MoveResources", - "description": "Begin moving resources.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", - "parameters": [ - { - "name": "sourceResourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Source resource group name.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourcesMoveInfo" - }, - "description": "move resources' parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "204": { - "description": "" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resources": { - "get": { - "tags": [ - "Resources" - ], - "operationId": "Resources_List", - "description": "Get all of the resources under a subscription.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/GenericResourceFilter" - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": { - "head": { - "tags": [ - "Resources" - ], - "operationId": "Resources_CheckExistence", - "description": "Checks whether resource exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "delete": { - "tags": [ - "Resources" - ], - "operationId": "Resources_Delete", - "description": "Delete resource and all of its resources. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - }, - "202": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Resources" - ], - "operationId": "Resources_CreateOrUpdate", - "description": "Create a resource.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GenericResource" - }, - "description": "Create or update resource parameters." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - } - } - }, - "get": { - "tags": [ - "Resources" - ], - "operationId": "Resources_Get", - "description": "Returns a resource belonging to a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - }, - "204": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": { - "delete": { - "tags": [ - "Tags" - ], - "operationId": "Tags_DeleteValue", - "description": "Delete a subscription resource tag value.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "name": "tagValue", - "in": "path", - "required": true, - "type": "string", - "description": "The value of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Tags" - ], - "operationId": "Tags_CreateOrUpdateValue", - "description": "Create a subscription resource tag value.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "name": "tagValue", - "in": "path", - "required": true, - "type": "string", - "description": "The value of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagValue" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/TagValue" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames/{tagName}": { - "put": { - "tags": [ - "Tags" - ], - "operationId": "Tags_CreateOrUpdate", - "description": "Create a subscription resource tag.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagDetails" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/TagDetails" - } - } - } - }, - "delete": { - "tags": [ - "Tags" - ], - "operationId": "Tags_Delete", - "description": "Delete a subscription resource tag.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames": { - "get": { - "tags": [ - "Tags" - ], - "operationId": "Tags_List", - "description": "Get a list of subscription resource tags.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": { - "get": { - "tags": [ - "DeploymentOperations" - ], - "operationId": "DeploymentOperations_Get", - "description": "Get a list of deployments operations.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "description": "Operation Id." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentOperation" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": { - "get": { - "tags": [ - "DeploymentOperations" - ], - "operationId": "DeploymentOperations_List", - "description": "Gets a list of deployments operations.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentOperationsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/{resourceProviderNamespace}/operations": { - "get": { - "tags": [ - "ResourceProviderOperationDetails" - ], - "operationId": "ResourceProviderOperationDetails_List", - "description": "Gets a list of resource providers.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationDetailListResult" - } - }, - "204": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationDetailListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}": { - "put": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_CreateOrUpdate", - "description": "Create or update policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyDefinition" - }, - "description": "The policy definition properties" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyDefinition" - } - } - } - }, - "get": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_Get", - "description": "Gets policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyDefinition" - } - } - } - }, - "delete": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_Delete", - "description": "Deletes policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForResource", - "description": "Gets policy assignments of the resource.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource provider." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "The parent resource path." - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "The resource type." - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource name." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForResourceGroup", - "description": "Gets policy assignments of the resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource group name." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}": { - "delete": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Delete", - "description": "Delete policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "put": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Create", - "description": "Create policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Get", - "description": "Get single policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - } - }, - "/{policyAssignmentId}": { - "delete": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_DeleteById", - "description": "Delete policy assignment.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "put": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_CreateById", - "description": "Create policy assignment by Id.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_GetById", - "description": "Get single policy assignment.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_List", - "description": "Gets policy assignments of the subscription.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForScope", - "description": "Gets policy assignments of the scope.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "PolicyAssignmentProperties": { - "properties": { - "scope": { - "type": "string", - "description": "Gets or sets the policy assignment scope." - }, - "displayName": { - "type": "string", - "description": "Gets or sets the policy assignment display name." - }, - "policyDefinitionId": { - "type": "string", - "description": "Gets or sets the policy definition Id." - } - }, - "description": "Policy Assignment properties." - }, - "PolicyAssignment": { - "properties": { - "properties": { - "$ref": "#/definitions/PolicyAssignmentProperties", - "description": "Gets or sets the policy assignment properties." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets or sets the policy assignment name." - } - }, - "description": "Policy assignment." - }, - "PolicyAssignmentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment list." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of policy assignment results." - } - }, - "description": "Policy assignment list operation result." - }, - "PolicyDefinitionProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the policy definition description." - }, - "displayName": { - "type": "string", - "description": "Gets or sets the policy definition display name." - }, - "policyRule": { - "type": "object", - "description": "The policy rule json." - } - }, - "description": "Policy definition properties." - }, - "PolicyDefinition": { - "properties": { - "properties": { - "$ref": "#/definitions/PolicyDefinitionProperties", - "description": "Gets or sets the policy definition properties." - }, - "name": { - "type": "string", - "description": "Gets or sets the policy definition name." - } - }, - "description": "Policy definition." - }, - "DeploymentExtendedFilter": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the provisioning state." - } - }, - "description": "Deployment filter." - }, - "GenericResourceFilter": { - "properties": { - "resourceType": { - "type": "string", - "description": "Gets or sets the resource type." - }, - "tagname": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "tagvalue": { - "type": "string", - "description": "Gets or sets the tag value." - } - }, - "description": "Resource filter." - }, - "ResourceGroupFilter": { - "properties": { - "tagName": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "tagValue": { - "type": "string", - "description": "Gets or sets the tag value." - } - }, - "description": "Resource group filter." - }, - "TemplateLink": { - "properties": { - "uri": { - "type": "string", - "description": "URI referencing the template." - }, - "contentVersion": { - "type": "string", - "description": "If included it must match the ContentVersion in the template." - } - }, - "required": [ - "uri" - ], - "description": "Entity representing the reference to the template." - }, - "ParametersLink": { - "properties": { - "uri": { - "type": "string", - "description": "URI referencing the template." - }, - "contentVersion": { - "type": "string", - "description": "If included it must match the ContentVersion in the template." - } - }, - "required": [ - "uri" - ], - "description": "Entity representing the reference to the deployment paramaters." - }, - "DeploymentProperties": { - "properties": { - "template": { - "type": "object", - "description": "Gets or sets the template content. Use only one of Template or TemplateLink." - }, - "templateLink": { - "$ref": "#/definitions/TemplateLink", - "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." - }, - "parameters": { - "type": "object", - "description": "Deployment parameters. Use only one of Parameters or ParametersLink." - }, - "parametersLink": { - "$ref": "#/definitions/ParametersLink", - "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." - }, - "mode": { - "type": "string", - "description": "Gets or sets the deployment mode.", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - } - } - }, - "description": "Deployment properties." - }, - "Deployment": { - "properties": { - "properties": { - "$ref": "#/definitions/DeploymentProperties", - "description": "Gets or sets the deployment properties." - } - }, - "description": "Deployment operation parameters." - }, - "ResourceManagementError": { - "properties": { - "code": { - "type": "string", - "description": "Gets or sets the error code returned from the server." - }, - "message": { - "type": "string", - "description": "Gets or sets the error message returned from the server." - }, - "target": { - "type": "string", - "description": "Gets or sets the target of the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "ResourceManagementErrorWithDetails": { - "properties": { - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceManagementError" - }, - "description": "Gets or sets validation error." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ResourceManagementError" - } - ], - "required": [ - "code", - "message" - ] - }, - "ProviderResourceType": { - "properties": { - "resourceType": { - "type": "string", - "description": "Gets or sets the resource type." - }, - "locations": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the collection of locations where this resource type can be created in." - }, - "apiVersions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the api version." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the properties." - } - }, - "description": "Resource type managed by the resource provider." - }, - "Provider": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the provider id." - }, - "namespace": { - "type": "string", - "description": "Gets or sets the namespace of the provider." - }, - "registrationState": { - "type": "string", - "description": "Gets or sets the registration state of the provider." - }, - "resourceTypes": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderResourceType" - }, - "description": "Gets or sets the collection of provider resource types." - } - }, - "description": "Resource provider information." - }, - "BasicDependency": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the dependency." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the dependency resource type." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the dependency resource name." - } - }, - "description": "Deployment dependency information." - }, - "Dependency": { - "properties": { - "dependsOn": { - "type": "array", - "items": { - "$ref": "#/definitions/BasicDependency" - }, - "description": "Gets the list of dependencies." - }, - "id": { - "type": "string", - "description": "Gets or sets the ID of the dependency." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the dependency resource type." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the dependency resource name." - } - }, - "description": "Deployment dependency information." - }, - "DeploymentPropertiesExtended": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the state of the provisioning." - }, - "correlationId": { - "type": "string", - "description": "Gets or sets the correlation ID of the deployment." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the timestamp of the template deployment." - }, - "outputs": { - "type": "object", - "description": "Gets or sets key/value pairs that represent deploymentoutput." - }, - "providers": { - "type": "array", - "items": { - "$ref": "#/definitions/Provider" - }, - "description": "Gets the list of resource providers needed for the deployment." - }, - "dependencies": { - "type": "array", - "items": { - "$ref": "#/definitions/Dependency" - }, - "description": "Gets the list of deployment dependencies." - }, - "template": { - "type": "object", - "description": "Gets or sets the template content. Use only one of Template or TemplateLink." - }, - "templateLink": { - "$ref": "#/definitions/TemplateLink", - "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." - }, - "parameters": { - "type": "object", - "description": "Deployment parameters. Use only one of Parameters or ParametersLink." - }, - "parametersLink": { - "$ref": "#/definitions/ParametersLink", - "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." - }, - "mode": { - "type": "string", - "description": "Gets or sets the deployment mode.", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - } - } - }, - "description": "Deployment properties with additional details." - }, - "DeploymentValidateResult": { - "properties": { - "error": { - "$ref": "#/definitions/ResourceManagementErrorWithDetails", - "description": "Gets or sets validation error." - }, - "properties": { - "$ref": "#/definitions/DeploymentPropertiesExtended", - "description": "Gets or sets the template deployment properties." - } - }, - "description": "Information from validate template deployment response." - }, - "DeploymentExtended": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the deployment." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the deployment." - }, - "properties": { - "$ref": "#/definitions/DeploymentPropertiesExtended", - "description": "Gets or sets deployment properties." - } - }, - "required": [ - "name" - ], - "description": "Deployment information." - }, - "DeploymentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DeploymentExtended" - }, - "description": "Gets or sets the list of deployments." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of deployments." - }, - "ProviderListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Provider" - }, - "description": "Gets or sets the list of resource providers." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of resource providers." - }, - "GenericResource": { - "properties": { - "plan": { - "$ref": "#/definitions/Plan", - "description": "Gets or sets the plan of the resource." - }, - "properties": { - "type": "object", - "description": "Gets or sets the resource properties." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Resource information." - }, - "Plan": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the plan ID." - }, - "publisher": { - "type": "string", - "description": "Gets or sets the publisher ID." - }, - "product": { - "type": "string", - "description": "Gets or sets the offer ID." - }, - "promotionCode": { - "type": "string", - "description": "Gets or sets the promotion code." - } - }, - "description": "Plan for the resource." - }, - "ResourceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GenericResource" - }, - "description": "Gets or sets the list of resource groups." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of resource groups." - }, - "ResourceGroup": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Gets the ID of the resource group." - }, - "name": { - "type": "string", - "description": "Gets or sets the Name of the resource group." - }, - "properties": { - "$ref": "#/definitions/ResourceGroupProperties" - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource group." - } - }, - "required": [ - "location" - ], - "description": "Resource group information." - }, - "ResourceGroupProperties": { - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets resource group provisioning state." - } - }, - "description": "The resource group properties." - }, - "ResourceGroupListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Gets or sets the list of resource groups." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of resource groups." - }, - "ResourcesMoveInfo": { - "properties": { - "resources": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the ids of the resources." - }, - "targetResourceGroup": { - "type": "string", - "description": "The target resource group." - } - }, - "description": "Parameters of move resources." - }, - "TagCount": { - "properties": { - "type": { - "type": "string", - "description": "Type of count." - }, - "value": { - "type": "string", - "description": "Value of count." - } - }, - "description": "Tag count." - }, - "TagValue": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the tag ID." - }, - "tagValue": { - "type": "string", - "description": "Gets or sets the tag value." - }, - "count": { - "$ref": "#/definitions/TagCount", - "description": "Gets or sets the tag value count." - } - }, - "description": "Tag information." - }, - "TagDetails": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the tag ID." - }, - "tagName": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "count": { - "$ref": "#/definitions/TagCount", - "description": "Gets or sets the tag count." - }, - "values": { - "type": "array", - "items": { - "$ref": "#/definitions/TagValue" - }, - "description": "Gets or sets the list of tag values." - } - }, - "description": "Tag details." - }, - "TagsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagDetails" - }, - "description": "Gets or sets the list of tags." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of subscription tags." - }, - "TargetResource": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the resource." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the name of the resource." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the type of the resource." - } - }, - "description": "Target resource." - }, - "DeploymentOperationProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the state of the provisioning." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the date and time of the operation." - }, - "statusCode": { - "type": "string", - "description": "Gets or sets operation status code." - }, - "statusMessage": { - "type": "object", - "description": "Gets or sets operation status message." - }, - "targetResource": { - "$ref": "#/definitions/TargetResource", - "description": "Gets or sets the target resource." - } - }, - "description": "Deployment operation properties." - }, - "DeploymentOperation": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets full deployment operation id." - }, - "operationId": { - "type": "string", - "description": "Gets or sets deployment operation id." - }, - "properties": { - "$ref": "#/definitions/DeploymentOperationProperties", - "description": "Gets or sets deployment properties." - } - }, - "description": "Deployment operation information." - }, - "DeploymentOperationsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DeploymentOperation" - }, - "description": "Gets or sets the list of deployments." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of deployment operations." - }, - "ResourceProviderOperationDisplayProperties": { - "properties": { - "publisher": { - "type": "string", - "description": "Gets or sets operation description." - }, - "provider": { - "type": "string", - "description": "Gets or sets operation provider." - }, - "resource": { - "type": "string", - "description": "Gets or sets operation resource." - }, - "operation": { - "type": "string", - "description": "Gets or sets operation." - }, - "description": { - "type": "string", - "description": "Gets or sets operation description." - } - }, - "description": "Resource provider operation's display properties." - }, - "ResourceProviderOperationDefinition": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the provider operation name." - }, - "display": { - "$ref": "#/definitions/ResourceProviderOperationDisplayProperties", - "description": "Gets or sets the display property of the provider operation." - } - }, - "description": "Resource provider operation information." - }, - "ResourceProviderOperationDetailListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceProviderOperationDefinition" - }, - "description": "Gets or sets the list of resource provider operations." - } - }, - "description": "List of resource provider operations." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": 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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "ResourceManagementClient", + "version": "2015-11-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Delete", + "description": "Begin deleting deployment.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "204": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistence", + "description": "Checks whether deployment exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to check. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdate", + "description": "Create a named template deployment using a template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Get", + "description": "Get a deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to get. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Cancel", + "description": "Cancel a currently running template deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Validate", + "description": "Validate a deployment template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Deployment to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "400": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_List", + "description": "Get a list of deployments.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to filter by. The name is case insensitive." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Unregister", + "description": "Unregisters provider from a subscription.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Register", + "description": "Registers provider to be used with a subscription.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_List", + "description": "Gets a list of resource providers.", + "parameters": [ + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ProviderListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Get", + "description": "Gets a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_ListResources", + "description": "Get all of the resources under a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GenericResourceFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": { + "head": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_CheckExistence", + "description": "Checks whether resource group exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to check. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "put": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_CreateOrUpdate", + "description": "Create a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be created or updated.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Parameters supplied to the create or update resource group service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + }, + "delete": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Delete", + "description": "Begin deleting resource group.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be deleted. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Get", + "description": "Get a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to get. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + }, + "patch": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Patch", + "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be created or updated. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Parameters supplied to the update state resource group service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_List", + "description": "Gets a collection of resource groups.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ResourceGroupFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": { + "post": { + "tags": [ + "Resources" + ], + "operationId": "Resources_MoveResources", + "description": "Begin moving resources.To determine whether the operation has finished processing the request, call GetLongRunningOperationStatus.", + "parameters": [ + { + "name": "sourceResourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Source resource group name.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourcesMoveInfo" + }, + "description": "move resources' parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "204": { + "description": "" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resources": { + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_List", + "description": "Get all of the resources under a subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GenericResourceFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": { + "head": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CheckExistence", + "description": "Checks whether resource exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "delete": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Delete", + "description": "Delete resource and all of its resources. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + }, + "202": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CreateOrUpdate", + "description": "Create a resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Create or update resource parameters." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + } + } + }, + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Get", + "description": "Returns a resource belonging to a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "204": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": { + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tags_DeleteValue", + "description": "Delete a subscription resource tag value.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "name": "tagValue", + "in": "path", + "required": true, + "type": "string", + "description": "The value of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tags_CreateOrUpdateValue", + "description": "Create a subscription resource tag value.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "name": "tagValue", + "in": "path", + "required": true, + "type": "string", + "description": "The value of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagValue" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/TagValue" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}": { + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tags_CreateOrUpdate", + "description": "Create a subscription resource tag.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagDetails" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/TagDetails" + } + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tags_Delete", + "description": "Delete a subscription resource tag.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tags_List", + "description": "Get a list of subscription resource tags.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_Get", + "description": "Get a list of deployments operations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation Id." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentOperation" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_List", + "description": "Gets a list of deployments operations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentOperationsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/{resourceProviderNamespace}/operations": { + "get": { + "tags": [ + "ResourceProviderOperationDetails" + ], + "operationId": "ResourceProviderOperationDetails_List", + "description": "Gets a list of resource providers.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationDetailListResult" + } + }, + "204": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationDetailListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}": { + "put": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_CreateOrUpdate", + "description": "Create or update policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyDefinition" + }, + "description": "The policy definition properties" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + }, + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_Get", + "description": "Gets policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + }, + "delete": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_Delete", + "description": "Deletes policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForResource", + "description": "Gets policy assignments of the resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource provider." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource path." + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource name." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForResourceGroup", + "description": "Gets policy assignments of the resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}": { + "delete": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Delete", + "description": "Delete policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "put": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Create", + "description": "Create policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Get", + "description": "Get single policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + } + }, + "/{policyAssignmentId}": { + "delete": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_DeleteById", + "description": "Delete policy assignment.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "put": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_CreateById", + "description": "Create policy assignment by Id.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_GetById", + "description": "Get single policy assignment.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_List", + "description": "Gets policy assignments of the subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForScope", + "description": "Gets policy assignments of the scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PolicyAssignmentProperties": { + "properties": { + "scope": { + "type": "string", + "description": "Gets or sets the policy assignment scope." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the policy assignment display name." + }, + "policyDefinitionId": { + "type": "string", + "description": "Gets or sets the policy definition Id." + } + }, + "description": "Policy Assignment properties." + }, + "PolicyAssignment": { + "properties": { + "properties": { + "$ref": "#/definitions/PolicyAssignmentProperties", + "description": "Gets or sets the policy assignment properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets or sets the policy assignment name." + } + }, + "description": "Policy assignment." + }, + "PolicyAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of policy assignment results." + } + }, + "description": "Policy assignment list operation result." + }, + "PolicyDefinitionProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the policy definition description." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the policy definition display name." + }, + "policyRule": { + "type": "object", + "description": "The policy rule json." + } + }, + "description": "Policy definition properties." + }, + "PolicyDefinition": { + "properties": { + "properties": { + "$ref": "#/definitions/PolicyDefinitionProperties", + "description": "Gets or sets the policy definition properties." + }, + "name": { + "type": "string", + "description": "Gets or sets the policy definition name." + } + }, + "description": "Policy definition." + }, + "DeploymentExtendedFilter": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the provisioning state." + } + }, + "description": "Deployment filter." + }, + "GenericResourceFilter": { + "properties": { + "resourceType": { + "type": "string", + "description": "Gets or sets the resource type." + }, + "tagname": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "tagvalue": { + "type": "string", + "description": "Gets or sets the tag value." + } + }, + "description": "Resource filter." + }, + "ResourceGroupFilter": { + "properties": { + "tagName": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "tagValue": { + "type": "string", + "description": "Gets or sets the tag value." + } + }, + "description": "Resource group filter." + }, + "TemplateLink": { + "properties": { + "uri": { + "type": "string", + "description": "URI referencing the template." + }, + "contentVersion": { + "type": "string", + "description": "If included it must match the ContentVersion in the template." + } + }, + "required": [ + "uri" + ], + "description": "Entity representing the reference to the template." + }, + "ParametersLink": { + "properties": { + "uri": { + "type": "string", + "description": "URI referencing the template." + }, + "contentVersion": { + "type": "string", + "description": "If included it must match the ContentVersion in the template." + } + }, + "required": [ + "uri" + ], + "description": "Entity representing the reference to the deployment paramaters." + }, + "DeploymentProperties": { + "properties": { + "template": { + "type": "object", + "description": "Gets or sets the template content. Use only one of Template or TemplateLink." + }, + "templateLink": { + "$ref": "#/definitions/TemplateLink", + "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." + }, + "parameters": { + "type": "object", + "description": "Deployment parameters. Use only one of Parameters or ParametersLink." + }, + "parametersLink": { + "$ref": "#/definitions/ParametersLink", + "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." + }, + "mode": { + "type": "string", + "description": "Gets or sets the deployment mode.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + } + }, + "description": "Deployment properties." + }, + "Deployment": { + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "Gets or sets the deployment properties." + } + }, + "description": "Deployment operation parameters." + }, + "ResourceManagementError": { + "properties": { + "code": { + "type": "string", + "description": "Gets or sets the error code returned from the server." + }, + "message": { + "type": "string", + "description": "Gets or sets the error message returned from the server." + }, + "target": { + "type": "string", + "description": "Gets or sets the target of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ResourceManagementErrorWithDetails": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceManagementError" + }, + "description": "Gets or sets validation error." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceManagementError" + } + ], + "required": [ + "code", + "message" + ] + }, + "ProviderResourceType": { + "properties": { + "resourceType": { + "type": "string", + "description": "Gets or sets the resource type." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the collection of locations where this resource type can be created in." + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the api version." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the properties." + } + }, + "description": "Resource type managed by the resource provider." + }, + "Provider": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the provider id." + }, + "namespace": { + "type": "string", + "description": "Gets or sets the namespace of the provider." + }, + "registrationState": { + "type": "string", + "description": "Gets or sets the registration state of the provider." + }, + "resourceTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderResourceType" + }, + "description": "Gets or sets the collection of provider resource types." + } + }, + "description": "Resource provider information." + }, + "BasicDependency": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the dependency." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the dependency resource type." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the dependency resource name." + } + }, + "description": "Deployment dependency information." + }, + "Dependency": { + "properties": { + "dependsOn": { + "type": "array", + "items": { + "$ref": "#/definitions/BasicDependency" + }, + "description": "Gets the list of dependencies." + }, + "id": { + "type": "string", + "description": "Gets or sets the ID of the dependency." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the dependency resource type." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the dependency resource name." + } + }, + "description": "Deployment dependency information." + }, + "DeploymentPropertiesExtended": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the state of the provisioning." + }, + "correlationId": { + "type": "string", + "description": "Gets or sets the correlation ID of the deployment." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the timestamp of the template deployment." + }, + "outputs": { + "type": "object", + "description": "Gets or sets key/value pairs that represent deploymentoutput." + }, + "providers": { + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "Gets the list of resource providers needed for the deployment." + }, + "dependencies": { + "type": "array", + "items": { + "$ref": "#/definitions/Dependency" + }, + "description": "Gets the list of deployment dependencies." + }, + "template": { + "type": "object", + "description": "Gets or sets the template content. Use only one of Template or TemplateLink." + }, + "templateLink": { + "$ref": "#/definitions/TemplateLink", + "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." + }, + "parameters": { + "type": "object", + "description": "Deployment parameters. Use only one of Parameters or ParametersLink." + }, + "parametersLink": { + "$ref": "#/definitions/ParametersLink", + "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." + }, + "mode": { + "type": "string", + "description": "Gets or sets the deployment mode.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + } + }, + "description": "Deployment properties with additional details." + }, + "DeploymentValidateResult": { + "properties": { + "error": { + "$ref": "#/definitions/ResourceManagementErrorWithDetails", + "description": "Gets or sets validation error." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "Gets or sets the template deployment properties." + } + }, + "description": "Information from validate template deployment response." + }, + "DeploymentExtended": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the deployment." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the deployment." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "Gets or sets deployment properties." + } + }, + "required": [ + "name" + ], + "description": "Deployment information." + }, + "DeploymentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentExtended" + }, + "description": "Gets or sets the list of deployments." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of deployments." + }, + "ProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "Gets or sets the list of resource providers." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of resource providers." + }, + "GenericResource": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Gets or sets the plan of the resource." + }, + "properties": { + "type": "object", + "description": "Gets or sets the resource properties." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Resource information." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the plan ID." + }, + "publisher": { + "type": "string", + "description": "Gets or sets the publisher ID." + }, + "product": { + "type": "string", + "description": "Gets or sets the offer ID." + }, + "promotionCode": { + "type": "string", + "description": "Gets or sets the promotion code." + } + }, + "description": "Plan for the resource." + }, + "ResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Gets or sets the list of resource groups." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of resource groups." + }, + "ResourceGroup": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Gets the ID of the resource group." + }, + "name": { + "type": "string", + "description": "Gets or sets the Name of the resource group." + }, + "properties": { + "$ref": "#/definitions/ResourceGroupProperties" + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource group." + } + }, + "required": [ + "location" + ], + "description": "Resource group information." + }, + "ResourceGroupProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets resource group provisioning state." + } + }, + "description": "The resource group properties." + }, + "ResourceGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Gets or sets the list of resource groups." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of resource groups." + }, + "ResourcesMoveInfo": { + "properties": { + "resources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the ids of the resources." + }, + "targetResourceGroup": { + "type": "string", + "description": "The target resource group." + } + }, + "description": "Parameters of move resources." + }, + "TagCount": { + "properties": { + "type": { + "type": "string", + "description": "Type of count." + }, + "value": { + "type": "string", + "description": "Value of count." + } + }, + "description": "Tag count." + }, + "TagValue": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the tag ID." + }, + "tagValue": { + "type": "string", + "description": "Gets or sets the tag value." + }, + "count": { + "$ref": "#/definitions/TagCount", + "description": "Gets or sets the tag value count." + } + }, + "description": "Tag information." + }, + "TagDetails": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the tag ID." + }, + "tagName": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "count": { + "$ref": "#/definitions/TagCount", + "description": "Gets or sets the tag count." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/TagValue" + }, + "description": "Gets or sets the list of tag values." + } + }, + "description": "Tag details." + }, + "TagsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagDetails" + }, + "description": "Gets or sets the list of tags." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of subscription tags." + }, + "TargetResource": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the resource." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the type of the resource." + } + }, + "description": "Target resource." + }, + "DeploymentOperationProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the state of the provisioning." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the date and time of the operation." + }, + "statusCode": { + "type": "string", + "description": "Gets or sets operation status code." + }, + "statusMessage": { + "type": "object", + "description": "Gets or sets operation status message." + }, + "targetResource": { + "$ref": "#/definitions/TargetResource", + "description": "Gets or sets the target resource." + } + }, + "description": "Deployment operation properties." + }, + "DeploymentOperation": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets full deployment operation id." + }, + "operationId": { + "type": "string", + "description": "Gets or sets deployment operation id." + }, + "properties": { + "$ref": "#/definitions/DeploymentOperationProperties", + "description": "Gets or sets deployment properties." + } + }, + "description": "Deployment operation information." + }, + "DeploymentOperationsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentOperation" + }, + "description": "Gets or sets the list of deployments." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of deployment operations." + }, + "ResourceProviderOperationDisplayProperties": { + "properties": { + "publisher": { + "type": "string", + "description": "Gets or sets operation description." + }, + "provider": { + "type": "string", + "description": "Gets or sets operation provider." + }, + "resource": { + "type": "string", + "description": "Gets or sets operation resource." + }, + "operation": { + "type": "string", + "description": "Gets or sets operation." + }, + "description": { + "type": "string", + "description": "Gets or sets operation description." + } + }, + "description": "Resource provider operation's display properties." + }, + "ResourceProviderOperationDefinition": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the provider operation name." + }, + "display": { + "$ref": "#/definitions/ResourceProviderOperationDisplayProperties", + "description": "Gets or sets the display property of the provider operation." + } + }, + "description": "Resource provider operation information." + }, + "ResourceProviderOperationDetailListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperationDefinition" + }, + "description": "Gets or sets the list of resource provider operations." + } + }, + "description": "List of resource provider operations." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": 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." + } + } } \ No newline at end of file diff --git a/arm-resources/resources/2016-02-01/swagger/resources.json b/arm-resources/resources/2016-02-01/swagger/resources.json index ad1464de0edc..83ddd2db7827 100644 --- a/arm-resources/resources/2016-02-01/swagger/resources.json +++ b/arm-resources/resources/2016-02-01/swagger/resources.json @@ -1,2967 +1,2967 @@ -{ - "swagger": "2.0", - "info": { - "title": "ResourceManagementClient", - "version": "2016-02-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { - "delete": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Delete", - "description": "Delete deployment.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment to be deleted." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "204": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "head": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_CheckExistence", - "description": "Checks whether deployment exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to check. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_CreateOrUpdate", - "description": "Create a named template deployment using a template.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - }, - "description": "Additional parameters supplied to the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Get", - "description": "Get a deployment.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to get. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExtended" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { - "post": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Cancel", - "description": "Cancel a currently running template deployment.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { - "post": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_Validate", - "description": "Validate a deployment template.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - }, - "description": "Deployment to validate." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentValidateResult" - } - }, - "400": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentValidateResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { - "post": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_ExportTemplate", - "description": "Exports a deployment template.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentExportResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": { - "get": { - "tags": [ - "Deployments" - ], - "operationId": "Deployments_List", - "description": "Get a list of deployments.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to filter by. The name is case insensitive." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all deployments." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/DeploymentExtendedFilter" - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": { - "post": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Unregister", - "description": "Unregisters provider from a subscription.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": { - "post": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Register", - "description": "Registers provider to be used with a subscription.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers": { - "get": { - "tags": [ - "Providers" - ], - "operationId": "Providers_List", - "description": "Gets a list of resource providers.", - "parameters": [ - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all deployments." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ProviderListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": { - "get": { - "tags": [ - "Providers" - ], - "operationId": "Providers_Get", - "description": "Gets a resource provider.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Namespace of the resource provider." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Provider" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": { - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_ListResources", - "description": "Get all of the resources under a subscription.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/GenericResourceFilter" - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": { - "head": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_CheckExistence", - "description": "Checks whether resource group exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to check. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "put": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_CreateOrUpdate", - "description": "Create a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be created or updated.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Parameters supplied to the create or update resource group service operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - }, - "delete": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_Delete", - "description": "Delete resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be deleted. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "200": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_Get", - "description": "Get a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to get. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - }, - "patch": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_Patch", - "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be created or updated. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Parameters supplied to the update state resource group service operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroup" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate": { - "post": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_ExportTemplate", - "description": "Captures the specified resource group as a template.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group to be created or updated.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ExportTemplateRequest" - }, - "description": "Parameters supplied to the export template resource group operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroupExportResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups": { - "get": { - "tags": [ - "ResourceGroups" - ], - "operationId": "ResourceGroups_List", - "description": "Gets a collection of resource groups.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceGroupListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/ResourceGroupFilter" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": { - "post": { - "tags": [ - "Resources" - ], - "operationId": "Resources_MoveResources", - "description": "Move resources from one resource group to another. The resources being moved should all be in the same resource group.", - "parameters": [ - { - "name": "sourceResourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Source resource group name.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ResourcesMoveInfo" - }, - "description": "move resources' parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "202": { - "description": "" - }, - "204": { - "description": "" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resources": { - "get": { - "tags": [ - "Resources" - ], - "operationId": "Resources_List", - "description": "Get all of the resources under a subscription.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters. If null is passed returns all resource groups." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/GenericResourceFilter" - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": { - "head": { - "tags": [ - "Resources" - ], - "operationId": "Resources_CheckExistence", - "description": "Checks whether resource exists.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "" - }, - "404": { - "description": "" - } - } - }, - "delete": { - "tags": [ - "Resources" - ], - "operationId": "Resources_Delete", - "description": "Delete resource and all of its resources. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - }, - "202": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Resources" - ], - "operationId": "Resources_CreateOrUpdate", - "description": "Create a resource.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/GenericResource" - }, - "description": "Create or update resource parameters." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - }, - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - } - } - }, - "get": { - "tags": [ - "Resources" - ], - "operationId": "Resources_Get", - "description": "Returns a resource belonging to a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/GenericResource" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": { - "delete": { - "tags": [ - "Tags" - ], - "operationId": "Tags_DeleteValue", - "description": "Delete a subscription resource tag value.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "name": "tagValue", - "in": "path", - "required": true, - "type": "string", - "description": "The value of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - }, - "put": { - "tags": [ - "Tags" - ], - "operationId": "Tags_CreateOrUpdateValue", - "description": "Create a subscription resource tag value.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "name": "tagValue", - "in": "path", - "required": true, - "type": "string", - "description": "The value of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagValue" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/TagValue" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames/{tagName}": { - "put": { - "tags": [ - "Tags" - ], - "operationId": "Tags_CreateOrUpdate", - "description": "Create a subscription resource tag.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagDetails" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/TagDetails" - } - } - } - }, - "delete": { - "tags": [ - "Tags" - ], - "operationId": "Tags_Delete", - "description": "Delete a subscription resource tag.", - "parameters": [ - { - "name": "tagName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the tag." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/tagNames": { - "get": { - "tags": [ - "Tags" - ], - "operationId": "Tags_List", - "description": "Get a list of subscription resource tags.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TagsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": { - "get": { - "tags": [ - "DeploymentOperations" - ], - "operationId": "DeploymentOperations_Get", - "description": "Get a list of deployments operations.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "operationId", - "in": "path", - "required": true, - "type": "string", - "description": "Operation Id." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentOperation" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": { - "get": { - "tags": [ - "DeploymentOperations" - ], - "operationId": "DeploymentOperations_List", - "description": "Gets a list of deployments operations.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group. The name is case insensitive.", - "pattern": "^[-\\w\\._]+$" - }, - { - "name": "deploymentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the deployment." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "description": "Query parameters." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/DeploymentOperationsListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/{resourceProviderNamespace}/operations": { - "get": { - "tags": [ - "ResourceProviderOperationDetails" - ], - "operationId": "ResourceProviderOperationDetails_List", - "description": "Gets a list of resource providers.", - "parameters": [ - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "Resource identity." - }, - { - "name": "api-version", - "in": "query", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationDetailListResult" - } - }, - "204": { - "description": "", - "schema": { - "$ref": "#/definitions/ResourceProviderOperationDetailListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}": { - "put": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_CreateOrUpdate", - "description": "Create or update policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyDefinition" - }, - "description": "The policy definition properties" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyDefinition" - } - } - } - }, - "get": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_Get", - "description": "Gets policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyDefinition" - } - } - } - }, - "delete": { - "tags": [ - "PolicyDefinitions" - ], - "operationId": "PolicyDefinitions_Delete", - "description": "Deletes policy definition.", - "parameters": [ - { - "name": "policyDefinitionName", - "in": "path", - "required": true, - "type": "string", - "description": "The policy definition name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForResource", - "description": "Gets policy assignments of the resource.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource provider." - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "The parent resource path." - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "The resource type." - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource name." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForResourceGroup", - "description": "Gets policy assignments of the resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource group name." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}": { - "delete": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Delete", - "description": "Delete policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "put": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Create", - "description": "Create policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_Get", - "description": "Get single policy assignment.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "policyAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment name." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - } - }, - "/{policyAssignmentId}": { - "delete": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_DeleteById", - "description": "Delete policy assignment.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "put": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_CreateById", - "description": "Create policy assignment by Id.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - }, - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_GetById", - "description": "Get single policy assignment.", - "parameters": [ - { - "name": "policyAssignmentId", - "in": "path", - "required": true, - "type": "string", - "description": "Policy assignment Id", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignment" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_List", - "description": "Gets policy assignments of the subscription.", - "parameters": [ - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Authorization/policyAssignments": { - "get": { - "tags": [ - "PolicyAssignments" - ], - "operationId": "PolicyAssignments_ListForScope", - "description": "Gets policy assignments of the scope.", - "parameters": [ - { - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "Scope.", - "x-ms-skip-url-encoding": true - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/PolicyAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "PolicyAssignmentProperties": { - "properties": { - "scope": { - "type": "string", - "description": "Gets or sets the policy assignment scope." - }, - "displayName": { - "type": "string", - "description": "Gets or sets the policy assignment display name." - }, - "policyDefinitionId": { - "type": "string", - "description": "Gets or sets the policy definition Id." - } - }, - "description": "Policy Assignment properties." - }, - "PolicyAssignment": { - "properties": { - "properties": { - "$ref": "#/definitions/PolicyAssignmentProperties", - "description": "Gets or sets the policy assignment properties." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets or sets the policy assignment name." - } - }, - "description": "Policy assignment." - }, - "PolicyAssignmentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PolicyAssignment" - }, - "description": "Policy assignment list." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of policy assignment results." - } - }, - "description": "Policy assignment list operation result." - }, - "PolicyDefinitionProperties": { - "properties": { - "description": { - "type": "string", - "description": "Gets or sets the policy definition description." - }, - "displayName": { - "type": "string", - "description": "Gets or sets the policy definition display name." - }, - "policyRule": { - "type": "object", - "description": "The policy rule json." - } - }, - "description": "Policy definition properties." - }, - "PolicyDefinition": { - "properties": { - "properties": { - "$ref": "#/definitions/PolicyDefinitionProperties", - "description": "Gets or sets the policy definition properties." - }, - "name": { - "type": "string", - "description": "Gets or sets the policy definition name." - } - }, - "description": "Policy definition." - }, - "DeploymentExtendedFilter": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the provisioning state." - } - }, - "description": "Deployment filter." - }, - "GenericResourceFilter": { - "properties": { - "resourceType": { - "type": "string", - "description": "Gets or sets the resource type." - }, - "tagname": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "tagvalue": { - "type": "string", - "description": "Gets or sets the tag value." - } - }, - "description": "Resource filter." - }, - "ResourceGroupFilter": { - "properties": { - "tagName": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "tagValue": { - "type": "string", - "description": "Gets or sets the tag value." - } - }, - "description": "Resource group filter." - }, - "TemplateLink": { - "properties": { - "uri": { - "type": "string", - "description": "URI referencing the template." - }, - "contentVersion": { - "type": "string", - "description": "If included it must match the ContentVersion in the template." - } - }, - "required": [ - "uri" - ], - "description": "Entity representing the reference to the template." - }, - "ParametersLink": { - "properties": { - "uri": { - "type": "string", - "description": "URI referencing the template." - }, - "contentVersion": { - "type": "string", - "description": "If included it must match the ContentVersion in the template." - } - }, - "required": [ - "uri" - ], - "description": "Entity representing the reference to the deployment paramaters." - }, - "DeploymentProperties": { - "properties": { - "template": { - "type": "object", - "description": "Gets or sets the template content. Use only one of Template or TemplateLink." - }, - "templateLink": { - "$ref": "#/definitions/TemplateLink", - "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." - }, - "parameters": { - "type": "object", - "description": "Deployment parameters. Use only one of Parameters or ParametersLink." - }, - "parametersLink": { - "$ref": "#/definitions/ParametersLink", - "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." - }, - "mode": { - "type": "string", - "description": "Gets or sets the deployment mode.", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - } - }, - "debugSetting": { - "$ref": "#/definitions/DebugSetting", - "description": "Gets or sets the debug setting of the deployment." - } - }, - "description": "Deployment properties." - }, - "DebugSetting": { - "properties": { - "detailLevel": { - "x-ms-client-flatten": true, - "type": "string", - "description": "Gets or sets the debug detail level." - } - } - }, - "Deployment": { - "properties": { - "properties": { - "$ref": "#/definitions/DeploymentProperties", - "description": "Gets or sets the deployment properties." - } - }, - "description": "Deployment operation parameters." - }, - "DeploymentExportResult": { - "properties": { - "template": { - "type": "object", - "description": "Gets or sets the template content." - } - } - }, - "ResourceManagementError": { - "properties": { - "code": { - "type": "string", - "description": "Gets or sets the error code returned from the server." - }, - "message": { - "type": "string", - "description": "Gets or sets the error message returned from the server." - }, - "target": { - "type": "string", - "description": "Gets or sets the target of the error." - } - }, - "required": [ - "code", - "message" - ] - }, - "ResourceManagementErrorWithDetails": { - "properties": { - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceManagementError" - }, - "description": "Gets or sets validation error." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ResourceManagementError" - } - ], - "required": [ - "code", - "message" - ] - }, - "ProviderResourceType": { - "properties": { - "resourceType": { - "type": "string", - "description": "Gets or sets the resource type." - }, - "locations": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the collection of locations where this resource type can be created in." - }, - "apiVersions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the api version." - }, - "properties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the properties." - } - }, - "description": "Resource type managed by the resource provider." - }, - "Provider": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the provider id." - }, - "namespace": { - "type": "string", - "description": "Gets or sets the namespace of the provider." - }, - "registrationState": { - "type": "string", - "description": "Gets or sets the registration state of the provider." - }, - "resourceTypes": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderResourceType" - }, - "description": "Gets or sets the collection of provider resource types." - } - }, - "description": "Resource provider information." - }, - "BasicDependency": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the dependency." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the dependency resource type." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the dependency resource name." - } - }, - "description": "Deployment dependency information." - }, - "Dependency": { - "properties": { - "dependsOn": { - "type": "array", - "items": { - "$ref": "#/definitions/BasicDependency" - }, - "description": "Gets the list of dependencies." - }, - "id": { - "type": "string", - "description": "Gets or sets the ID of the dependency." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the dependency resource type." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the dependency resource name." - } - }, - "description": "Deployment dependency information." - }, - "DeploymentPropertiesExtended": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the state of the provisioning." - }, - "correlationId": { - "type": "string", - "description": "Gets or sets the correlation ID of the deployment." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the timestamp of the template deployment." - }, - "outputs": { - "type": "object", - "description": "Gets or sets key/value pairs that represent deploymentoutput." - }, - "providers": { - "type": "array", - "items": { - "$ref": "#/definitions/Provider" - }, - "description": "Gets the list of resource providers needed for the deployment." - }, - "dependencies": { - "type": "array", - "items": { - "$ref": "#/definitions/Dependency" - }, - "description": "Gets the list of deployment dependencies." - }, - "template": { - "type": "object", - "description": "Gets or sets the template content. Use only one of Template or TemplateLink." - }, - "templateLink": { - "$ref": "#/definitions/TemplateLink", - "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." - }, - "parameters": { - "type": "object", - "description": "Deployment parameters. Use only one of Parameters or ParametersLink." - }, - "parametersLink": { - "$ref": "#/definitions/ParametersLink", - "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." - }, - "mode": { - "type": "string", - "description": "Gets or sets the deployment mode.", - "enum": [ - "Incremental", - "Complete" - ], - "x-ms-enum": { - "name": "DeploymentMode", - "modelAsString": false - } - }, - "debugSetting": { - "$ref": "#/definitions/DebugSetting", - "description": "Gets or sets the debug setting of the deployment." - } - }, - "description": "Deployment properties with additional details." - }, - "DeploymentValidateResult": { - "properties": { - "error": { - "$ref": "#/definitions/ResourceManagementErrorWithDetails", - "description": "Gets or sets validation error." - }, - "properties": { - "$ref": "#/definitions/DeploymentPropertiesExtended", - "description": "Gets or sets the template deployment properties." - } - }, - "description": "Information from validate template deployment response." - }, - "DeploymentExtended": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the deployment." - }, - "name": { - "type": "string", - "description": "Gets or sets the name of the deployment." - }, - "properties": { - "$ref": "#/definitions/DeploymentPropertiesExtended", - "description": "Gets or sets deployment properties." - } - }, - "required": [ - "name" - ], - "description": "Deployment information." - }, - "DeploymentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DeploymentExtended" - }, - "description": "Gets or sets the list of deployments." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of deployments." - }, - "ProviderListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Provider" - }, - "description": "Gets or sets the list of resource providers." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of resource providers." - }, - "GenericResource": { - "properties": { - "plan": { - "$ref": "#/definitions/Plan", - "description": "Gets or sets the plan of the resource." - }, - "properties": { - "type": "object", - "description": "Gets or sets the resource properties." - } - }, - "allOf": [ - { - "$ref": "Resource" - } - ], - "description": "Resource information." - }, - "Plan": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the plan ID." - }, - "publisher": { - "type": "string", - "description": "Gets or sets the publisher ID." - }, - "product": { - "type": "string", - "description": "Gets or sets the offer ID." - }, - "promotionCode": { - "type": "string", - "description": "Gets or sets the promotion code." - } - }, - "description": "Plan for the resource." - }, - "ResourceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GenericResource" - }, - "description": "Gets or sets the list of resource groups." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of resource groups." - }, - "ResourceGroup": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Gets the ID of the resource group." - }, - "name": { - "type": "string", - "description": "Gets or sets the Name of the resource group." - }, - "properties": { - "$ref": "#/definitions/ResourceGroupProperties" - }, - "location": { - "type": "string", - "description": "Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags attached to the resource group." - } - }, - "required": [ - "location" - ], - "description": "Resource group information." - }, - "ResourceGroupProperties": { - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets resource group provisioning state." - } - }, - "description": "The resource group properties." - }, - "ResourceGroupListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceGroup" - }, - "description": "Gets or sets the list of resource groups." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of resource groups." - }, - "ResourcesMoveInfo": { - "properties": { - "resources": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the ids of the resources." - }, - "targetResourceGroup": { - "type": "string", - "description": "The target resource group." - } - }, - "description": "Parameters of move resources." - }, - "ExportTemplateRequest": { - "properties": { - "resources": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Gets or sets the ids of the resources. The only supported string currently is '*' (all resources). Future api updates will support exporting specific resources." - }, - "options": { - "type": "string", - "description": "The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" - } - }, - "description": "Export resource group template request parameters." - }, - "TagCount": { - "properties": { - "type": { - "type": "string", - "description": "Type of count." - }, - "value": { - "type": "string", - "description": "Value of count." - } - }, - "description": "Tag count." - }, - "TagValue": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the tag ID." - }, - "tagValue": { - "type": "string", - "description": "Gets or sets the tag value." - }, - "count": { - "$ref": "#/definitions/TagCount", - "description": "Gets or sets the tag value count." - } - }, - "description": "Tag information." - }, - "TagDetails": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the tag ID." - }, - "tagName": { - "type": "string", - "description": "Gets or sets the tag name." - }, - "count": { - "$ref": "#/definitions/TagCount", - "description": "Gets or sets the tag count." - }, - "values": { - "type": "array", - "items": { - "$ref": "#/definitions/TagValue" - }, - "description": "Gets or sets the list of tag values." - } - }, - "description": "Tag details." - }, - "TagsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TagDetails" - }, - "description": "Gets or sets the list of tags." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "List of subscription tags." - }, - "TargetResource": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the resource." - }, - "resourceName": { - "type": "string", - "description": "Gets or sets the name of the resource." - }, - "resourceType": { - "type": "string", - "description": "Gets or sets the type of the resource." - } - }, - "description": "Target resource." - }, - "HttpMessage": { - "properties": { - "content": { - "type": "object", - "description": "Gets or sets HTTP message content." - } - } - }, - "DeploymentOperationProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets or sets the state of the provisioning." - }, - "timestamp": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the date and time of the operation." - }, - "serviceRequestId": { - "type": "string", - "description": "Gets or sets deployment operation service request id." - }, - "statusCode": { - "type": "string", - "description": "Gets or sets operation status code." - }, - "statusMessage": { - "type": "object", - "description": "Gets or sets operation status message." - }, - "targetResource": { - "$ref": "#/definitions/TargetResource", - "description": "Gets or sets the target resource." - }, - "request": { - "$ref": "#/definitions/HttpMessage", - "description": "Gets or sets the HTTP request message." - }, - "response": { - "$ref": "#/definitions/HttpMessage", - "description": "Gets or sets the HTTP response message." - } - }, - "description": "Deployment operation properties." - }, - "DeploymentOperation": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets full deployment operation id." - }, - "operationId": { - "type": "string", - "description": "Gets or sets deployment operation id." - }, - "properties": { - "$ref": "#/definitions/DeploymentOperationProperties", - "description": "Gets or sets deployment properties." - } - }, - "description": "Deployment operation information." - }, - "DeploymentOperationsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DeploymentOperation" - }, - "description": "Gets or sets the list of deployments." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "description": "List of deployment operations." - }, - "ResourceProviderOperationDisplayProperties": { - "properties": { - "publisher": { - "type": "string", - "description": "Gets or sets operation description." - }, - "provider": { - "type": "string", - "description": "Gets or sets operation provider." - }, - "resource": { - "type": "string", - "description": "Gets or sets operation resource." - }, - "operation": { - "type": "string", - "description": "Gets or sets operation." - }, - "description": { - "type": "string", - "description": "Gets or sets operation description." - } - }, - "description": "Resource provider operation's display properties." - }, - "ResourceProviderOperationDefinition": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the provider operation name." - }, - "display": { - "$ref": "#/definitions/ResourceProviderOperationDisplayProperties", - "description": "Gets or sets the display property of the provider operation." - } - }, - "description": "Resource provider operation information." - }, - "ResourceProviderOperationDetailListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceProviderOperationDefinition" - }, - "description": "Gets or sets the list of resource provider operations." - } - }, - "description": "List of resource provider operations." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": true - }, - "ResourceGroupExportResult": { - "properties": { - "template": { - "type": "object", - "description": "Gets or sets the template content." - }, - "error": { - "$ref": "#/definitions/ResourceManagementErrorWithDetails", - "description": "Gets or sets the error." - } - } - } - }, - "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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "ResourceManagementClient", + "version": "2016-02-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Delete", + "description": "Delete deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment to be deleted." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "204": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistence", + "description": "Checks whether deployment exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to check. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdate", + "description": "Create a named template deployment using a template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Get", + "description": "Get a deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to get. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Cancel", + "description": "Cancel a currently running template deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Validate", + "description": "Validate a deployment template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Deployment to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "400": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ExportTemplate", + "description": "Exports a deployment template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentExportResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_List", + "description": "Get a list of deployments.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to filter by. The name is case insensitive." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Unregister", + "description": "Unregisters provider from a subscription.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Register", + "description": "Registers provider to be used with a subscription.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_List", + "description": "Gets a list of resource providers.", + "parameters": [ + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ProviderListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Get", + "description": "Gets a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Provider" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_ListResources", + "description": "Get all of the resources under a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GenericResourceFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": { + "head": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_CheckExistence", + "description": "Checks whether resource group exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to check. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "put": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_CreateOrUpdate", + "description": "Create a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be created or updated.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Parameters supplied to the create or update resource group service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + }, + "delete": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Delete", + "description": "Delete resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be deleted. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "200": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Get", + "description": "Get a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to get. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + }, + "patch": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Patch", + "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource groups, though if a field is unspecified current value will be carried over. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be created or updated. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Parameters supplied to the update state resource group service operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate": { + "post": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_ExportTemplate", + "description": "Captures the specified resource group as a template.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to be created or updated.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportTemplateRequest" + }, + "description": "Parameters supplied to the export template resource group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroupExportResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_List", + "description": "Gets a collection of resource groups.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ResourceGroupFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": { + "post": { + "tags": [ + "Resources" + ], + "operationId": "Resources_MoveResources", + "description": "Move resources from one resource group to another. The resources being moved should all be in the same resource group.", + "parameters": [ + { + "name": "sourceResourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Source resource group name.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourcesMoveInfo" + }, + "description": "move resources' parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "" + }, + "204": { + "description": "" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resources": { + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_List", + "description": "Get all of the resources under a subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters. If null is passed returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GenericResourceFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": { + "head": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CheckExistence", + "description": "Checks whether resource exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + } + } + }, + "delete": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Delete", + "description": "Delete resource and all of its resources. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + }, + "202": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CreateOrUpdate", + "description": "Create a resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Create or update resource parameters." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + } + } + }, + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Get", + "description": "Returns a resource belonging to a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GenericResource" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": { + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tags_DeleteValue", + "description": "Delete a subscription resource tag value.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "name": "tagValue", + "in": "path", + "required": true, + "type": "string", + "description": "The value of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tags_CreateOrUpdateValue", + "description": "Create a subscription resource tag value.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "name": "tagValue", + "in": "path", + "required": true, + "type": "string", + "description": "The value of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagValue" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/TagValue" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}": { + "put": { + "tags": [ + "Tags" + ], + "operationId": "Tags_CreateOrUpdate", + "description": "Create a subscription resource tag.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagDetails" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/TagDetails" + } + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "operationId": "Tags_Delete", + "description": "Delete a subscription resource tag.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "Tags_List", + "description": "Get a list of subscription resource tags.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TagsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_Get", + "description": "Get a list of deployments operations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation Id." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentOperation" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_List", + "description": "Gets a list of deployments operations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the deployment." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Query parameters." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DeploymentOperationsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/{resourceProviderNamespace}/operations": { + "get": { + "tags": [ + "ResourceProviderOperationDetails" + ], + "operationId": "ResourceProviderOperationDetails_List", + "description": "Gets a list of resource providers.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "Resource identity." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationDetailListResult" + } + }, + "204": { + "description": "", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationDetailListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policydefinitions/{policyDefinitionName}": { + "put": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_CreateOrUpdate", + "description": "Create or update policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyDefinition" + }, + "description": "The policy definition properties" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + }, + "get": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_Get", + "description": "Gets policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyDefinition" + } + } + } + }, + "delete": { + "tags": [ + "PolicyDefinitions" + ], + "operationId": "PolicyDefinitions_Delete", + "description": "Deletes policy definition.", + "parameters": [ + { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The policy definition name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForResource", + "description": "Gets policy assignments of the resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource provider." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource path." + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource name." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForResourceGroup", + "description": "Gets policy assignments of the resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}": { + "delete": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Delete", + "description": "Delete policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "put": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Create", + "description": "Create policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_Get", + "description": "Get single policy assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + } + }, + "/{policyAssignmentId}": { + "delete": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_DeleteById", + "description": "Delete policy assignment.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "put": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_CreateById", + "description": "Create policy assignment by Id.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + }, + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_GetById", + "description": "Get single policy assignment.", + "parameters": [ + { + "name": "policyAssignmentId", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment Id", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignment" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_List", + "description": "Gets policy assignments of the subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Authorization/policyAssignments": { + "get": { + "tags": [ + "PolicyAssignments" + ], + "operationId": "PolicyAssignments_ListForScope", + "description": "Gets policy assignments of the scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "Scope.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/PolicyAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PolicyAssignmentProperties": { + "properties": { + "scope": { + "type": "string", + "description": "Gets or sets the policy assignment scope." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the policy assignment display name." + }, + "policyDefinitionId": { + "type": "string", + "description": "Gets or sets the policy definition Id." + } + }, + "description": "Policy Assignment properties." + }, + "PolicyAssignment": { + "properties": { + "properties": { + "$ref": "#/definitions/PolicyAssignmentProperties", + "description": "Gets or sets the policy assignment properties." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets or sets the policy assignment name." + } + }, + "description": "Policy assignment." + }, + "PolicyAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyAssignment" + }, + "description": "Policy assignment list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of policy assignment results." + } + }, + "description": "Policy assignment list operation result." + }, + "PolicyDefinitionProperties": { + "properties": { + "description": { + "type": "string", + "description": "Gets or sets the policy definition description." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the policy definition display name." + }, + "policyRule": { + "type": "object", + "description": "The policy rule json." + } + }, + "description": "Policy definition properties." + }, + "PolicyDefinition": { + "properties": { + "properties": { + "$ref": "#/definitions/PolicyDefinitionProperties", + "description": "Gets or sets the policy definition properties." + }, + "name": { + "type": "string", + "description": "Gets or sets the policy definition name." + } + }, + "description": "Policy definition." + }, + "DeploymentExtendedFilter": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the provisioning state." + } + }, + "description": "Deployment filter." + }, + "GenericResourceFilter": { + "properties": { + "resourceType": { + "type": "string", + "description": "Gets or sets the resource type." + }, + "tagname": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "tagvalue": { + "type": "string", + "description": "Gets or sets the tag value." + } + }, + "description": "Resource filter." + }, + "ResourceGroupFilter": { + "properties": { + "tagName": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "tagValue": { + "type": "string", + "description": "Gets or sets the tag value." + } + }, + "description": "Resource group filter." + }, + "TemplateLink": { + "properties": { + "uri": { + "type": "string", + "description": "URI referencing the template." + }, + "contentVersion": { + "type": "string", + "description": "If included it must match the ContentVersion in the template." + } + }, + "required": [ + "uri" + ], + "description": "Entity representing the reference to the template." + }, + "ParametersLink": { + "properties": { + "uri": { + "type": "string", + "description": "URI referencing the template." + }, + "contentVersion": { + "type": "string", + "description": "If included it must match the ContentVersion in the template." + } + }, + "required": [ + "uri" + ], + "description": "Entity representing the reference to the deployment paramaters." + }, + "DeploymentProperties": { + "properties": { + "template": { + "type": "object", + "description": "Gets or sets the template content. Use only one of Template or TemplateLink." + }, + "templateLink": { + "$ref": "#/definitions/TemplateLink", + "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." + }, + "parameters": { + "type": "object", + "description": "Deployment parameters. Use only one of Parameters or ParametersLink." + }, + "parametersLink": { + "$ref": "#/definitions/ParametersLink", + "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." + }, + "mode": { + "type": "string", + "description": "Gets or sets the deployment mode.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + }, + "debugSetting": { + "$ref": "#/definitions/DebugSetting", + "description": "Gets or sets the debug setting of the deployment." + } + }, + "description": "Deployment properties." + }, + "DebugSetting": { + "properties": { + "detailLevel": { + "x-ms-client-flatten": true, + "type": "string", + "description": "Gets or sets the debug detail level." + } + } + }, + "Deployment": { + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "Gets or sets the deployment properties." + } + }, + "description": "Deployment operation parameters." + }, + "DeploymentExportResult": { + "properties": { + "template": { + "type": "object", + "description": "Gets or sets the template content." + } + } + }, + "ResourceManagementError": { + "properties": { + "code": { + "type": "string", + "description": "Gets or sets the error code returned from the server." + }, + "message": { + "type": "string", + "description": "Gets or sets the error message returned from the server." + }, + "target": { + "type": "string", + "description": "Gets or sets the target of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ResourceManagementErrorWithDetails": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceManagementError" + }, + "description": "Gets or sets validation error." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceManagementError" + } + ], + "required": [ + "code", + "message" + ] + }, + "ProviderResourceType": { + "properties": { + "resourceType": { + "type": "string", + "description": "Gets or sets the resource type." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the collection of locations where this resource type can be created in." + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the api version." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the properties." + } + }, + "description": "Resource type managed by the resource provider." + }, + "Provider": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the provider id." + }, + "namespace": { + "type": "string", + "description": "Gets or sets the namespace of the provider." + }, + "registrationState": { + "type": "string", + "description": "Gets or sets the registration state of the provider." + }, + "resourceTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderResourceType" + }, + "description": "Gets or sets the collection of provider resource types." + } + }, + "description": "Resource provider information." + }, + "BasicDependency": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the dependency." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the dependency resource type." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the dependency resource name." + } + }, + "description": "Deployment dependency information." + }, + "Dependency": { + "properties": { + "dependsOn": { + "type": "array", + "items": { + "$ref": "#/definitions/BasicDependency" + }, + "description": "Gets the list of dependencies." + }, + "id": { + "type": "string", + "description": "Gets or sets the ID of the dependency." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the dependency resource type." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the dependency resource name." + } + }, + "description": "Deployment dependency information." + }, + "DeploymentPropertiesExtended": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the state of the provisioning." + }, + "correlationId": { + "type": "string", + "description": "Gets or sets the correlation ID of the deployment." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the timestamp of the template deployment." + }, + "outputs": { + "type": "object", + "description": "Gets or sets key/value pairs that represent deploymentoutput." + }, + "providers": { + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "Gets the list of resource providers needed for the deployment." + }, + "dependencies": { + "type": "array", + "items": { + "$ref": "#/definitions/Dependency" + }, + "description": "Gets the list of deployment dependencies." + }, + "template": { + "type": "object", + "description": "Gets or sets the template content. Use only one of Template or TemplateLink." + }, + "templateLink": { + "$ref": "#/definitions/TemplateLink", + "description": "Gets or sets the URI referencing the template. Use only one of Template or TemplateLink." + }, + "parameters": { + "type": "object", + "description": "Deployment parameters. Use only one of Parameters or ParametersLink." + }, + "parametersLink": { + "$ref": "#/definitions/ParametersLink", + "description": "Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink." + }, + "mode": { + "type": "string", + "description": "Gets or sets the deployment mode.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + }, + "debugSetting": { + "$ref": "#/definitions/DebugSetting", + "description": "Gets or sets the debug setting of the deployment." + } + }, + "description": "Deployment properties with additional details." + }, + "DeploymentValidateResult": { + "properties": { + "error": { + "$ref": "#/definitions/ResourceManagementErrorWithDetails", + "description": "Gets or sets validation error." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "Gets or sets the template deployment properties." + } + }, + "description": "Information from validate template deployment response." + }, + "DeploymentExtended": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the deployment." + }, + "name": { + "type": "string", + "description": "Gets or sets the name of the deployment." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "Gets or sets deployment properties." + } + }, + "required": [ + "name" + ], + "description": "Deployment information." + }, + "DeploymentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentExtended" + }, + "description": "Gets or sets the list of deployments." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of deployments." + }, + "ProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "Gets or sets the list of resource providers." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of resource providers." + }, + "GenericResource": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Gets or sets the plan of the resource." + }, + "properties": { + "type": "object", + "description": "Gets or sets the resource properties." + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ], + "description": "Resource information." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the plan ID." + }, + "publisher": { + "type": "string", + "description": "Gets or sets the publisher ID." + }, + "product": { + "type": "string", + "description": "Gets or sets the offer ID." + }, + "promotionCode": { + "type": "string", + "description": "Gets or sets the promotion code." + } + }, + "description": "Plan for the resource." + }, + "ResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Gets or sets the list of resource groups." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of resource groups." + }, + "ResourceGroup": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Gets the ID of the resource group." + }, + "name": { + "type": "string", + "description": "Gets or sets the Name of the resource group." + }, + "properties": { + "$ref": "#/definitions/ResourceGroupProperties" + }, + "location": { + "type": "string", + "description": "Gets or sets the location of the resource group. It cannot be changed after the resource group has been created. Has to be one of the supported Azure Locations, such as West US, East US, West Europe, East Asia, etc." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags attached to the resource group." + } + }, + "required": [ + "location" + ], + "description": "Resource group information." + }, + "ResourceGroupProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets resource group provisioning state." + } + }, + "description": "The resource group properties." + }, + "ResourceGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Gets or sets the list of resource groups." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of resource groups." + }, + "ResourcesMoveInfo": { + "properties": { + "resources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the ids of the resources." + }, + "targetResourceGroup": { + "type": "string", + "description": "The target resource group." + } + }, + "description": "Parameters of move resources." + }, + "ExportTemplateRequest": { + "properties": { + "resources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the ids of the resources. The only supported string currently is '*' (all resources). Future api updates will support exporting specific resources." + }, + "options": { + "type": "string", + "description": "The export template options. Supported values include 'IncludeParameterDefaultValue', 'IncludeComments' or 'IncludeParameterDefaultValue, IncludeComments" + } + }, + "description": "Export resource group template request parameters." + }, + "TagCount": { + "properties": { + "type": { + "type": "string", + "description": "Type of count." + }, + "value": { + "type": "string", + "description": "Value of count." + } + }, + "description": "Tag count." + }, + "TagValue": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the tag ID." + }, + "tagValue": { + "type": "string", + "description": "Gets or sets the tag value." + }, + "count": { + "$ref": "#/definitions/TagCount", + "description": "Gets or sets the tag value count." + } + }, + "description": "Tag information." + }, + "TagDetails": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the tag ID." + }, + "tagName": { + "type": "string", + "description": "Gets or sets the tag name." + }, + "count": { + "$ref": "#/definitions/TagCount", + "description": "Gets or sets the tag count." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/TagValue" + }, + "description": "Gets or sets the list of tag values." + } + }, + "description": "Tag details." + }, + "TagsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagDetails" + }, + "description": "Gets or sets the list of tags." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "List of subscription tags." + }, + "TargetResource": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the resource." + }, + "resourceName": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "resourceType": { + "type": "string", + "description": "Gets or sets the type of the resource." + } + }, + "description": "Target resource." + }, + "HttpMessage": { + "properties": { + "content": { + "type": "object", + "description": "Gets or sets HTTP message content." + } + } + }, + "DeploymentOperationProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets or sets the state of the provisioning." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the date and time of the operation." + }, + "serviceRequestId": { + "type": "string", + "description": "Gets or sets deployment operation service request id." + }, + "statusCode": { + "type": "string", + "description": "Gets or sets operation status code." + }, + "statusMessage": { + "type": "object", + "description": "Gets or sets operation status message." + }, + "targetResource": { + "$ref": "#/definitions/TargetResource", + "description": "Gets or sets the target resource." + }, + "request": { + "$ref": "#/definitions/HttpMessage", + "description": "Gets or sets the HTTP request message." + }, + "response": { + "$ref": "#/definitions/HttpMessage", + "description": "Gets or sets the HTTP response message." + } + }, + "description": "Deployment operation properties." + }, + "DeploymentOperation": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets full deployment operation id." + }, + "operationId": { + "type": "string", + "description": "Gets or sets deployment operation id." + }, + "properties": { + "$ref": "#/definitions/DeploymentOperationProperties", + "description": "Gets or sets deployment properties." + } + }, + "description": "Deployment operation information." + }, + "DeploymentOperationsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentOperation" + }, + "description": "Gets or sets the list of deployments." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "description": "List of deployment operations." + }, + "ResourceProviderOperationDisplayProperties": { + "properties": { + "publisher": { + "type": "string", + "description": "Gets or sets operation description." + }, + "provider": { + "type": "string", + "description": "Gets or sets operation provider." + }, + "resource": { + "type": "string", + "description": "Gets or sets operation resource." + }, + "operation": { + "type": "string", + "description": "Gets or sets operation." + }, + "description": { + "type": "string", + "description": "Gets or sets operation description." + } + }, + "description": "Resource provider operation's display properties." + }, + "ResourceProviderOperationDefinition": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the provider operation name." + }, + "display": { + "$ref": "#/definitions/ResourceProviderOperationDisplayProperties", + "description": "Gets or sets the display property of the provider operation." + } + }, + "description": "Resource provider operation information." + }, + "ResourceProviderOperationDetailListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceProviderOperationDefinition" + }, + "description": "Gets or sets the list of resource provider operations." + } + }, + "description": "List of resource provider operations." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "ResourceGroupExportResult": { + "properties": { + "template": { + "type": "object", + "description": "Gets or sets the template content." + }, + "error": { + "$ref": "#/definitions/ResourceManagementErrorWithDetails", + "description": "Gets or sets the error." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } } \ No newline at end of file diff --git a/arm-resources/subscriptions/2015-11-01/swagger/subscriptions.json b/arm-resources/subscriptions/2015-11-01/swagger/subscriptions.json index 63996f760473..c224f8521bb3 100644 --- a/arm-resources/subscriptions/2015-11-01/swagger/subscriptions.json +++ b/arm-resources/subscriptions/2015-11-01/swagger/subscriptions.json @@ -1,291 +1,291 @@ -{ - "swagger": "2.0", - "info": { - "title": "SubscriptionClient", - "version": "2015-11-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/locations": { - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_ListLocations", - "description": "Gets a list of the subscription locations.", - "parameters": [ - { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Id of the subscription" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/LocationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}": { - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_Get", - "description": "Gets details about particular subscription.", - "parameters": [ - { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Id of the subscription." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/Subscription" - } - } - } - } - }, - "/subscriptions": { - "get": { - "tags": [ - "Subscriptions" - ], - "operationId": "Subscriptions_List", - "description": "Gets a list of the subscriptionIds.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SubscriptionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/tenants": { - "get": { - "tags": [ - "Tenants" - ], - "operationId": "Tenants_List", - "description": "Gets a list of the tenantIds.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/TenantListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "Location": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the resource (/subscriptions/SubscriptionId)." - }, - "subscriptionId": { - "type": "string", - "description": "Gets or sets the subscription Id." - }, - "name": { - "type": "string", - "description": "Gets or sets the location name" - }, - "displayName": { - "type": "string", - "description": "Gets or sets the display name of the location" - }, - "latitude": { - "type": "string", - "description": "Gets or sets the latitude of the location" - }, - "longitude": { - "type": "string", - "description": "Gets or sets the longitude of the location" - } - }, - "description": "Location information." - }, - "LocationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Location" - }, - "description": "Gets the locations." - } - }, - "description": "Location list operation response." - }, - "Subscription": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets the ID of the resource (/subscriptions/SubscriptionId)." - }, - "subscriptionId": { - "type": "string", - "description": "Gets or sets the subscription Id." - }, - "displayName": { - "type": "string", - "description": "Gets or sets the subscription display name" - }, - "state": { - "type": "string", - "description": "Gets or sets the subscription state" - }, - "subscriptionPolicies": { - "$ref": "#/definitions/SubscriptionPolicies", - "description": "Gets or sets the subscription policies." - } - }, - "description": "Subscription information." - }, - "SubscriptionPolicies": { - "properties": { - "locationPlacementId": { - "type": "string", - "description": "Gets or sets the subscription location placement Id." - }, - "quotaId": { - "type": "string", - "description": "Gets or sets the subscription quota Id." - } - }, - "description": "Subscription policies." - }, - "SubscriptionListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Subscription" - }, - "description": "Gets or sets subscriptions." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "Subscription list operation response." - }, - "TenantIdDescription": { - "properties": { - "id": { - "type": "string", - "description": "Gets or sets Id" - }, - "tenantId": { - "type": "string", - "description": "Gets or sets tenantId" - } - }, - "description": "Tenant Id information" - }, - "TenantListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/TenantIdDescription" - }, - "description": "Gets or sets tenant Ids." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of results." - } - }, - "required": [ - "nextLink" - ], - "description": "Tenant Ids information." - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "SubscriptionClient", + "version": "2015-11-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/locations": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_ListLocations", + "description": "Gets a list of the subscription locations.", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the subscription" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/LocationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_Get", + "description": "Gets details about particular subscription.", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the subscription." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/Subscription" + } + } + } + } + }, + "/subscriptions": { + "get": { + "tags": [ + "Subscriptions" + ], + "operationId": "Subscriptions_List", + "description": "Gets a list of the subscriptionIds.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SubscriptionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/tenants": { + "get": { + "tags": [ + "Tenants" + ], + "operationId": "Tenants_List", + "description": "Gets a list of the tenantIds.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/TenantListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Location": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the resource (/subscriptions/SubscriptionId)." + }, + "subscriptionId": { + "type": "string", + "description": "Gets or sets the subscription Id." + }, + "name": { + "type": "string", + "description": "Gets or sets the location name" + }, + "displayName": { + "type": "string", + "description": "Gets or sets the display name of the location" + }, + "latitude": { + "type": "string", + "description": "Gets or sets the latitude of the location" + }, + "longitude": { + "type": "string", + "description": "Gets or sets the longitude of the location" + } + }, + "description": "Location information." + }, + "LocationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Location" + }, + "description": "Gets the locations." + } + }, + "description": "Location list operation response." + }, + "Subscription": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets the ID of the resource (/subscriptions/SubscriptionId)." + }, + "subscriptionId": { + "type": "string", + "description": "Gets or sets the subscription Id." + }, + "displayName": { + "type": "string", + "description": "Gets or sets the subscription display name" + }, + "state": { + "type": "string", + "description": "Gets or sets the subscription state" + }, + "subscriptionPolicies": { + "$ref": "#/definitions/SubscriptionPolicies", + "description": "Gets or sets the subscription policies." + } + }, + "description": "Subscription information." + }, + "SubscriptionPolicies": { + "properties": { + "locationPlacementId": { + "type": "string", + "description": "Gets or sets the subscription location placement Id." + }, + "quotaId": { + "type": "string", + "description": "Gets or sets the subscription quota Id." + } + }, + "description": "Subscription policies." + }, + "SubscriptionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Subscription" + }, + "description": "Gets or sets subscriptions." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "Subscription list operation response." + }, + "TenantIdDescription": { + "properties": { + "id": { + "type": "string", + "description": "Gets or sets Id" + }, + "tenantId": { + "type": "string", + "description": "Gets or sets tenantId" + } + }, + "description": "Tenant Id information" + }, + "TenantListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TenantIdDescription" + }, + "description": "Gets or sets tenant Ids." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of results." + } + }, + "required": [ + "nextLink" + ], + "description": "Tenant Ids information." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/arm-scheduler/2014-08-01-preview/swagger/scheduler.json b/arm-scheduler/2014-08-01-preview/swagger/scheduler.json index 3bbd50e72e91..b7e781848d64 100644 --- a/arm-scheduler/2014-08-01-preview/swagger/scheduler.json +++ b/arm-scheduler/2014-08-01-preview/swagger/scheduler.json @@ -1,1624 +1,1624 @@ -{ - "swagger": "2.0", - "info": { - "title": "SchedulerManagementClient", - "version": "2014-08-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_ListBySubscription", - "description": "Gets all job collections under specified subscription.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collections have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_ListByResourceGroup", - "description": "Gets all job collections under specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collections have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Get", - "description": "Gets a job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "put": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_CreateOrUpdate", - "description": "Provisions a new job collection or updates an existing job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "jobCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "The job collection definition." - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully updated.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - }, - "201": { - "description": "The job collection has been successfully created.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "patch": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Patch", - "description": "Patches an existing job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "jobCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "The job collection definition." - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully patched.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "delete": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Delete", - "description": "Deletes a job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully deleted." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable": { - "post": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Enable", - "description": "Enables all of the jobs in the job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "All of the jobs in the job collection have been successfully enabled." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable": { - "post": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Disable", - "description": "Disables all of the jobs in the job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "All of the jobs in the job collection have been successfully disabled." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Get", - "description": "Gets a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "put": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_CreateOrUpdate", - "description": "Provisions a new job or updates an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "The job definition." - } - ], - "responses": { - "200": { - "description": "The job has been successfully updated.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - }, - "201": { - "description": "The job has been successfully created.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "patch": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Patch", - "description": "Patches an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "The job definition." - } - ], - "responses": { - "200": { - "description": "The job has been successfully patched.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "delete": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Delete", - "description": "Deletes a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully deleted." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run": { - "post": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Run", - "description": "Runs a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully run." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_List", - "description": "Lists all jobs under the specified job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "description": "The number of jobs to request, in the of range [1..100]." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "The (0-based) index of the job history list from which to begin requesting entries." - }, - { - "name": "$filter", - "description": "The filter to apply on the job state.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The job has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/JobStateFilter" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_ListJobHistory", - "description": "Lists job history.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "description": "the number of job history to request, in the of range [1..100]." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "The (0-based) index of the job history list from which to begin requesting entries." - }, - { - "name": "$filter", - "description": "The filter to apply on the job state.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The job histories have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobHistoryListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/JobHistoryFilter" - } - } - }, - "definitions": { - "JobCollectionListResult": { - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "Gets the job collections." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of job collections." - } - } - }, - "JobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "Gets or sets all jobs under job collection." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of jobs." - } - } - }, - "JobHistoryListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobHistoryDefinition" - }, - "description": "Gets or sets the job histories under job." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of job histories." - } - } - }, - "JobCollectionDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job collection resource identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job collection resource type." - }, - "name": { - "type": "string", - "description": "Gets or sets the job collection resource name." - }, - "location": { - "type": "string", - "description": "Gets or sets the storage account location." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags." - }, - "properties": { - "$ref": "#/definitions/JobCollectionProperties", - "description": "Gets or sets the job collection properties." - } - } - }, - "JobCollectionProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU." - }, - "state": { - "type": "string", - "description": "Gets or sets the state.", - "enum": [ - "Enabled", - "Disabled", - "Suspended", - "Deleted" - ], - "x-ms-enum": { - "name": "JobCollectionState", - "modelAsString": false - } - }, - "quota": { - "$ref": "#/definitions/JobCollectionQuota", - "description": "Gets or sets the job collection quota." - } - } - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "Gets or set the SKU.", - "enum": [ - "Standard", - "Free", - "Premium" - ], - "x-ms-enum": { - "name": "SkuDefinition", - "modelAsString": false - } - } - } - }, - "JobCollectionQuota": { - "properties": { - "maxJobCount": { - "type": "integer", - "description": "Gets or set the maximum job count." - }, - "maxJobOccurrence": { - "type": "integer", - "description": "Gets or sets the maximum job occurrence." - }, - "maxRecurrence": { - "$ref": "#/definitions/JobMaxRecurrence", - "description": "Gets or set the maximum recurrence." - } - } - }, - "JobDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource name." - }, - "properties": { - "$ref": "#/definitions/JobProperties", - "description": "Gets or sets the job properties." - } - } - }, - "JobProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the job start time." - }, - "action": { - "$ref": "#/definitions/JobAction", - "description": "Gets or sets the job action." - }, - "recurrence": { - "$ref": "#/definitions/JobRecurrence", - "description": "Gets or sets the job recurrence." - }, - "state": { - "$ref": "#/definitions/JobState", - "description": "Gets or set the job state." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "readOnly": true, - "description": "Gets the job status." - } - } - }, - "JobHistoryDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job history identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job history resource type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the job history name." - }, - "properties": { - "$ref": "#/definitions/JobHistoryDefinitionProperties", - "readOnly": true, - "description": "Gets or sets the job history properties." - } - } - }, - "JobHistoryDefinitionProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the start time for this job." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the end time for this job." - }, - "expectedExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the expected execution time for this job." - }, - "actionName": { - "type": "string", - "readOnly": true, - "description": "Gets the job history action name.", - "enum": [ - "MainAction", - "ErrorAction" - ], - "x-ms-enum": { - "name": "JobHistoryActionName", - "modelAsString": false - } - }, - "status": { - "$ref": "#/definitions/JobExecutionStatus", - "readOnly": true, - "description": "Gets the job history status." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "Gets the message for the job history." - }, - "retryCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the retry count for job." - }, - "repeatCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the repeat count for the job." - } - } - }, - "JobAction": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the job action type.", - "enum": [ - "Http", - "Https", - "StorageQueue", - "ServiceBusQueue", - "ServiceBusTopic" - ], - "x-ms-enum": { - "name": "JobActionType", - "modelAsString": false - } - }, - "request": { - "$ref": "#/definitions/HttpRequest", - "description": "Gets or sets the http requests." - }, - "queueMessage": { - "$ref": "#/definitions/StorageQueueMessage", - "description": "Gets or sets the storage queue message." - }, - "serviceBusQueueMessage": { - "$ref": "#/definitions/ServiceBusQueueMessage", - "description": "Gets or sets the service bus queue message." - }, - "serviceBusTopicMessage": { - "$ref": "#/definitions/ServiceBusTopicMessage", - "description": "Gets or sets the service bus topic message." - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Gets or sets the retry policy." - }, - "errorAction": { - "$ref": "#/definitions/JobErrorAction", - "description": "Gets or sets the error action." - } - } - }, - "JobErrorAction": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the job error action type.", - "enum": [ - "Http", - "Https", - "StorageQueue", - "ServiceBusQueue", - "ServiceBusTopic" - ], - "x-ms-enum": { - "name": "JobActionType", - "modelAsString": false - } - }, - "request": { - "$ref": "#/definitions/HttpRequest", - "description": "Gets or sets the http requests." - }, - "queueMessage": { - "$ref": "#/definitions/StorageQueueMessage", - "description": "Gets or sets the storage queue message." - }, - "serviceBusQueueMessage": { - "$ref": "#/definitions/ServiceBusQueueMessage", - "description": "Gets or sets the service bus queue message." - }, - "serviceBusTopicMessage": { - "$ref": "#/definitions/ServiceBusTopicMessage", - "description": "Gets or sets the service bus topic message." - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Gets or sets the retry policy." - } - } - }, - "HttpRequest": { - "properties": { - "authentication": { - "$ref": "#/definitions/HttpAuthentication", - "description": "Gets or sets the http authentication." - }, - "uri": { - "type": "string", - "description": "Gets or sets the Uri." - }, - "method": { - "type": "string", - "description": "Gets or sets the method of the request." - }, - "body": { - "type": "string", - "description": "Gets or sets the request body." - }, - "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the headers." - } - } - }, - "ClientCertAuthentication": { - "properties": { - "password": { - "type": "string", - "description": "Gets or sets the password." - }, - "pfx": { - "type": "string", - "description": "Gets or sets the pfx." - }, - "certificateThumbprint": { - "type": "string", - "description": "Gets or sets the certificate thumbprint." - }, - "certificateExpirationDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the certificate expiration date." - }, - "certificateSubjectName": { - "type": "string", - "description": "Gets or sets the certificate subject name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "BasicAuthentication": { - "properties": { - "username": { - "type": "string", - "description": "Gets or sets the username." - }, - "password": { - "type": "string", - "description": "Gets or sets the password." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "OAuthAuthentication": { - "properties": { - "secret": { - "type": "string", - "description": "Gets or sets the secret." - }, - "tenant": { - "type": "string", - "description": "Gets or sets the tenant." - }, - "audience": { - "type": "string", - "description": "Gets or sets the audience." - }, - "clientId": { - "type": "string", - "description": "Gets or sets the client identifier." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "HttpAuthentication": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the http authentication type.", - "enum": [ - "NotSpecified", - "ClientCertificate", - "ActiveDirectoryOAuth", - "Basic" - ], - "x-ms-enum": { - "name": "HttpAuthenticationType", - "modelAsString": false - } - } - } - }, - "StorageQueueMessage": { - "properties": { - "storageAccount": { - "type": "string", - "description": "Gets or sets the storage account name." - }, - "queueName": { - "type": "string", - "description": "Gets or sets the queue name." - }, - "sasToken": { - "type": "string", - "description": "Gets or sets the SAS key." - }, - "message": { - "type": "string", - "description": "Gets or sets the message." - } - } - }, - "ServiceBusQueueMessage": { - "properties": { - "queueName": { - "type": "string", - "description": "Gets or sets the queue name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ServiceBusMessage" - } - ] - }, - "ServiceBusTopicMessage": { - "properties": { - "topicPath": { - "type": "string", - "description": "Gets or sets the topic path." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ServiceBusMessage" - } - ] - }, - "ServiceBusMessage": { - "properties": { - "authentication": { - "$ref": "#/definitions/ServiceBusAuthentication", - "description": "Gets or sets the authentication." - }, - "brokeredMessageProperties": { - "$ref": "#/definitions/ServiceBusBrokeredMessageProperties", - "description": "Gets or sets the brokered message properties." - }, - "customMessageProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the custom message properties." - }, - "message": { - "type": "string", - "description": "Gets or sets the message." - }, - "namespace": { - "type": "string", - "description": "Gets or sets the namespace." - }, - "transportType": { - "type": "string", - "description": "Gets or sets the transport type.", - "enum": [ - "NotSpecified", - "NetMessaging", - "AMQP" - ], - "x-ms-enum": { - "name": "ServiceBusTransportType", - "modelAsString": false - } - } - } - }, - "ServiceBusAuthentication": { - "properties": { - "sasKey": { - "type": "string", - "description": "Gets or sets the SAS key." - }, - "sasKeyName": { - "type": "string", - "description": "Gets or sets the SAS key name." - }, - "type": { - "type": "string", - "description": "Gets or sets the authentication type.", - "enum": [ - "NotSpecified", - "SharedAccessKey" - ], - "x-ms-enum": { - "name": "ServiceBusAuthenticationType", - "modelAsString": false - } - } - } - }, - "ServiceBusBrokeredMessageProperties": { - "properties": { - "contentType": { - "type": "string", - "description": "Gets or sets the content type." - }, - "correlationId": { - "type": "string", - "description": "Gets or sets the correlation id." - }, - "forcePersistence": { - "type": "boolean", - "description": "Gets or sets the force persistence." - }, - "label": { - "type": "string", - "description": "Gets or sets the label." - }, - "messageId": { - "type": "string", - "description": "Gets or sets the message id." - }, - "partitionKey": { - "type": "string", - "description": "Gets or sets the partition key." - }, - "replyTo": { - "type": "string", - "description": "Gets or sets the reply to." - }, - "replyToSessionId": { - "type": "string", - "description": "Gets or sets the reply to session id." - }, - "scheduledEnqueueTimeUtc": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the scheduled enqueue time UTC." - }, - "sessionId": { - "type": "string", - "description": "Gets or sets the session id." - }, - "timeToLive": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the time to live." - }, - "to": { - "type": "string", - "description": "Gets or sets the to." - }, - "viaPartitionKey": { - "type": "string", - "description": "Gets or sets the via partition key." - } - } - }, - "RetryPolicy": { - "properties": { - "retryType": { - "type": "string", - "description": "Gets or sets the retry strategy to be used.", - "enum": [ - "None", - "Fixed" - ], - "x-ms-enum": { - "name": "RetryType", - "modelAsString": false - } - }, - "retryInterval": { - "type": "string", - "format": "duration", - "description": "Gets or sets the retry interval between retries." - }, - "retryCount": { - "type": "integer", - "description": "Gets or sets the number of times a retry should be attempted." - } - } - }, - "JobMaxRecurrence": { - "properties": { - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval between retries." - } - } - }, - "JobRecurrence": { - "properties": { - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval between retries." - }, - "count": { - "type": "integer", - "description": "Gets or sets the maximum number of times that the job should run." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the time at which the job will complete." - }, - "schedule": { - "$ref": "#/definitions/JobRecurrenceSchedule" - } - } - }, - "RecurrenceFrequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "JobRecurrenceSchedule": { - "properties": { - "weekDays": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "DayOfWeek", - "modelAsString": false - } - }, - "description": "Gets or sets the days of the week that the job should execute on." - }, - "hours": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the hours of the day that the job should execute at." - }, - "minutes": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the minutes of the hour that the job should execute at." - }, - "monthDays": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the days of the month that the job should execute on. Must be between 1 and 31." - }, - "monthlyOccurrences": { - "type": "array", - "items": { - "$ref": "#/definitions/JobRecurrenceScheduleMonthlyOccurrence" - }, - "description": "Gets or sets the occurrences of days within a month." - } - } - }, - "JobRecurrenceScheduleMonthlyOccurrence": { - "properties": { - "day": { - "type": "string", - "description": "Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "JobScheduleDay", - "modelAsString": false - } - }, - "Occurrence": { - "type": "integer", - "description": "Gets or sets the occurrence. Must be between -5 and 5." - } - } - }, - "JobStateFilter": { - "type": "object", - "properties": { - "state": { - "$ref": "#/definitions/JobState", - "description": "Gets or sets the job state." - } - } - }, - "JobState": { - "type": "string", - "description": "Gets or set the job state.", - "enum": [ - "Enabled", - "Disabled", - "Faulted", - "Completed" - ], - "x-ms-enum": { - "name": "JobState", - "modelAsString": false - } - }, - "JobHistoryFilter": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/JobExecutionStatus", - "description": "Gets or sets the job execution status." - } - } - }, - "JobExecutionStatus": { - "type": "string", - "description": "Gets the job execution status.", - "enum": [ - "Completed", - "Failed", - "Postponed" - ], - "x-ms-enum": { - "name": "JobExecutionStatus", - "modelAsString": false - } - }, - "JobStatus": { - "properties": { - "executionCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of times this job has executed." - }, - "failureCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of times this job has failed." - }, - "faultedCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states)." - }, - "lastExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet." - }, - "nextExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed." - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "description": "The subscription id.", - "in": "path", - "required": true, - "type": "string" - }, - "api-version": { - "name": "api-version", - "description": "The API version.", - "in": "query", - "required": true, - "type": "string" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "SchedulerManagementClient", + "version": "2014-08-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_ListBySubscription", + "description": "Gets all job collections under specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collections have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_ListByResourceGroup", + "description": "Gets all job collections under specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collections have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Get", + "description": "Gets a job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "put": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_CreateOrUpdate", + "description": "Provisions a new job collection or updates an existing job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "jobCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "The job collection definition." + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully updated.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + }, + "201": { + "description": "The job collection has been successfully created.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "patch": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Patch", + "description": "Patches an existing job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "jobCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "The job collection definition." + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully patched.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "delete": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Delete", + "description": "Deletes a job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable": { + "post": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Enable", + "description": "Enables all of the jobs in the job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "All of the jobs in the job collection have been successfully enabled." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable": { + "post": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Disable", + "description": "Disables all of the jobs in the job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "All of the jobs in the job collection have been successfully disabled." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Get", + "description": "Gets a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_CreateOrUpdate", + "description": "Provisions a new job or updates an existing job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "job", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "The job definition." + } + ], + "responses": { + "200": { + "description": "The job has been successfully updated.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "201": { + "description": "The job has been successfully created.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Patch", + "description": "Patches an existing job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "job", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "The job definition." + } + ], + "responses": { + "200": { + "description": "The job has been successfully patched.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Delete", + "description": "Deletes a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Run", + "description": "Runs a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully run." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_List", + "description": "Lists all jobs under the specified job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "The number of jobs to request, in the of range [1..100]." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The (0-based) index of the job history list from which to begin requesting entries." + }, + { + "name": "$filter", + "description": "The filter to apply on the job state.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The job has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobStateFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_ListJobHistory", + "description": "Lists job history.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "the number of job history to request, in the of range [1..100]." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The (0-based) index of the job history list from which to begin requesting entries." + }, + { + "name": "$filter", + "description": "The filter to apply on the job state.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The job histories have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobHistoryListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobHistoryFilter" + } + } + }, + "definitions": { + "JobCollectionListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "Gets the job collections." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of job collections." + } + } + }, + "JobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "Gets or sets all jobs under job collection." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of jobs." + } + } + }, + "JobHistoryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobHistoryDefinition" + }, + "description": "Gets or sets the job histories under job." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of job histories." + } + } + }, + "JobCollectionDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job collection resource identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job collection resource type." + }, + "name": { + "type": "string", + "description": "Gets or sets the job collection resource name." + }, + "location": { + "type": "string", + "description": "Gets or sets the storage account location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags." + }, + "properties": { + "$ref": "#/definitions/JobCollectionProperties", + "description": "Gets or sets the job collection properties." + } + } + }, + "JobCollectionProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU." + }, + "state": { + "type": "string", + "description": "Gets or sets the state.", + "enum": [ + "Enabled", + "Disabled", + "Suspended", + "Deleted" + ], + "x-ms-enum": { + "name": "JobCollectionState", + "modelAsString": false + } + }, + "quota": { + "$ref": "#/definitions/JobCollectionQuota", + "description": "Gets or sets the job collection quota." + } + } + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or set the SKU.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "SkuDefinition", + "modelAsString": false + } + } + } + }, + "JobCollectionQuota": { + "properties": { + "maxJobCount": { + "type": "integer", + "description": "Gets or set the maximum job count." + }, + "maxJobOccurrence": { + "type": "integer", + "description": "Gets or sets the maximum job occurrence." + }, + "maxRecurrence": { + "$ref": "#/definitions/JobMaxRecurrence", + "description": "Gets or set the maximum recurrence." + } + } + }, + "JobDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource type." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource name." + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Gets or sets the job properties." + } + } + }, + "JobProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the job start time." + }, + "action": { + "$ref": "#/definitions/JobAction", + "description": "Gets or sets the job action." + }, + "recurrence": { + "$ref": "#/definitions/JobRecurrence", + "description": "Gets or sets the job recurrence." + }, + "state": { + "$ref": "#/definitions/JobState", + "description": "Gets or set the job state." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "readOnly": true, + "description": "Gets the job status." + } + } + }, + "JobHistoryDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job history identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job history resource type." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the job history name." + }, + "properties": { + "$ref": "#/definitions/JobHistoryDefinitionProperties", + "readOnly": true, + "description": "Gets or sets the job history properties." + } + } + }, + "JobHistoryDefinitionProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time for this job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time for this job." + }, + "expectedExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the expected execution time for this job." + }, + "actionName": { + "type": "string", + "readOnly": true, + "description": "Gets the job history action name.", + "enum": [ + "MainAction", + "ErrorAction" + ], + "x-ms-enum": { + "name": "JobHistoryActionName", + "modelAsString": false + } + }, + "status": { + "$ref": "#/definitions/JobExecutionStatus", + "readOnly": true, + "description": "Gets the job history status." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Gets the message for the job history." + }, + "retryCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the retry count for job." + }, + "repeatCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the repeat count for the job." + } + } + }, + "JobAction": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the job action type.", + "enum": [ + "Http", + "Https", + "StorageQueue", + "ServiceBusQueue", + "ServiceBusTopic" + ], + "x-ms-enum": { + "name": "JobActionType", + "modelAsString": false + } + }, + "request": { + "$ref": "#/definitions/HttpRequest", + "description": "Gets or sets the http requests." + }, + "queueMessage": { + "$ref": "#/definitions/StorageQueueMessage", + "description": "Gets or sets the storage queue message." + }, + "serviceBusQueueMessage": { + "$ref": "#/definitions/ServiceBusQueueMessage", + "description": "Gets or sets the service bus queue message." + }, + "serviceBusTopicMessage": { + "$ref": "#/definitions/ServiceBusTopicMessage", + "description": "Gets or sets the service bus topic message." + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Gets or sets the retry policy." + }, + "errorAction": { + "$ref": "#/definitions/JobErrorAction", + "description": "Gets or sets the error action." + } + } + }, + "JobErrorAction": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the job error action type.", + "enum": [ + "Http", + "Https", + "StorageQueue", + "ServiceBusQueue", + "ServiceBusTopic" + ], + "x-ms-enum": { + "name": "JobActionType", + "modelAsString": false + } + }, + "request": { + "$ref": "#/definitions/HttpRequest", + "description": "Gets or sets the http requests." + }, + "queueMessage": { + "$ref": "#/definitions/StorageQueueMessage", + "description": "Gets or sets the storage queue message." + }, + "serviceBusQueueMessage": { + "$ref": "#/definitions/ServiceBusQueueMessage", + "description": "Gets or sets the service bus queue message." + }, + "serviceBusTopicMessage": { + "$ref": "#/definitions/ServiceBusTopicMessage", + "description": "Gets or sets the service bus topic message." + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Gets or sets the retry policy." + } + } + }, + "HttpRequest": { + "properties": { + "authentication": { + "$ref": "#/definitions/HttpAuthentication", + "description": "Gets or sets the http authentication." + }, + "uri": { + "type": "string", + "description": "Gets or sets the Uri." + }, + "method": { + "type": "string", + "description": "Gets or sets the method of the request." + }, + "body": { + "type": "string", + "description": "Gets or sets the request body." + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the headers." + } + } + }, + "ClientCertAuthentication": { + "properties": { + "password": { + "type": "string", + "description": "Gets or sets the password." + }, + "pfx": { + "type": "string", + "description": "Gets or sets the pfx." + }, + "certificateThumbprint": { + "type": "string", + "description": "Gets or sets the certificate thumbprint." + }, + "certificateExpirationDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the certificate expiration date." + }, + "certificateSubjectName": { + "type": "string", + "description": "Gets or sets the certificate subject name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "BasicAuthentication": { + "properties": { + "username": { + "type": "string", + "description": "Gets or sets the username." + }, + "password": { + "type": "string", + "description": "Gets or sets the password." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "OAuthAuthentication": { + "properties": { + "secret": { + "type": "string", + "description": "Gets or sets the secret." + }, + "tenant": { + "type": "string", + "description": "Gets or sets the tenant." + }, + "audience": { + "type": "string", + "description": "Gets or sets the audience." + }, + "clientId": { + "type": "string", + "description": "Gets or sets the client identifier." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "HttpAuthentication": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the http authentication type.", + "enum": [ + "NotSpecified", + "ClientCertificate", + "ActiveDirectoryOAuth", + "Basic" + ], + "x-ms-enum": { + "name": "HttpAuthenticationType", + "modelAsString": false + } + } + } + }, + "StorageQueueMessage": { + "properties": { + "storageAccount": { + "type": "string", + "description": "Gets or sets the storage account name." + }, + "queueName": { + "type": "string", + "description": "Gets or sets the queue name." + }, + "sasToken": { + "type": "string", + "description": "Gets or sets the SAS key." + }, + "message": { + "type": "string", + "description": "Gets or sets the message." + } + } + }, + "ServiceBusQueueMessage": { + "properties": { + "queueName": { + "type": "string", + "description": "Gets or sets the queue name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServiceBusMessage" + } + ] + }, + "ServiceBusTopicMessage": { + "properties": { + "topicPath": { + "type": "string", + "description": "Gets or sets the topic path." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServiceBusMessage" + } + ] + }, + "ServiceBusMessage": { + "properties": { + "authentication": { + "$ref": "#/definitions/ServiceBusAuthentication", + "description": "Gets or sets the authentication." + }, + "brokeredMessageProperties": { + "$ref": "#/definitions/ServiceBusBrokeredMessageProperties", + "description": "Gets or sets the brokered message properties." + }, + "customMessageProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the custom message properties." + }, + "message": { + "type": "string", + "description": "Gets or sets the message." + }, + "namespace": { + "type": "string", + "description": "Gets or sets the namespace." + }, + "transportType": { + "type": "string", + "description": "Gets or sets the transport type.", + "enum": [ + "NotSpecified", + "NetMessaging", + "AMQP" + ], + "x-ms-enum": { + "name": "ServiceBusTransportType", + "modelAsString": false + } + } + } + }, + "ServiceBusAuthentication": { + "properties": { + "sasKey": { + "type": "string", + "description": "Gets or sets the SAS key." + }, + "sasKeyName": { + "type": "string", + "description": "Gets or sets the SAS key name." + }, + "type": { + "type": "string", + "description": "Gets or sets the authentication type.", + "enum": [ + "NotSpecified", + "SharedAccessKey" + ], + "x-ms-enum": { + "name": "ServiceBusAuthenticationType", + "modelAsString": false + } + } + } + }, + "ServiceBusBrokeredMessageProperties": { + "properties": { + "contentType": { + "type": "string", + "description": "Gets or sets the content type." + }, + "correlationId": { + "type": "string", + "description": "Gets or sets the correlation id." + }, + "forcePersistence": { + "type": "boolean", + "description": "Gets or sets the force persistence." + }, + "label": { + "type": "string", + "description": "Gets or sets the label." + }, + "messageId": { + "type": "string", + "description": "Gets or sets the message id." + }, + "partitionKey": { + "type": "string", + "description": "Gets or sets the partition key." + }, + "replyTo": { + "type": "string", + "description": "Gets or sets the reply to." + }, + "replyToSessionId": { + "type": "string", + "description": "Gets or sets the reply to session id." + }, + "scheduledEnqueueTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the scheduled enqueue time UTC." + }, + "sessionId": { + "type": "string", + "description": "Gets or sets the session id." + }, + "timeToLive": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time to live." + }, + "to": { + "type": "string", + "description": "Gets or sets the to." + }, + "viaPartitionKey": { + "type": "string", + "description": "Gets or sets the via partition key." + } + } + }, + "RetryPolicy": { + "properties": { + "retryType": { + "type": "string", + "description": "Gets or sets the retry strategy to be used.", + "enum": [ + "None", + "Fixed" + ], + "x-ms-enum": { + "name": "RetryType", + "modelAsString": false + } + }, + "retryInterval": { + "type": "string", + "format": "duration", + "description": "Gets or sets the retry interval between retries." + }, + "retryCount": { + "type": "integer", + "description": "Gets or sets the number of times a retry should be attempted." + } + } + }, + "JobMaxRecurrence": { + "properties": { + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval between retries." + } + } + }, + "JobRecurrence": { + "properties": { + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval between retries." + }, + "count": { + "type": "integer", + "description": "Gets or sets the maximum number of times that the job should run." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time at which the job will complete." + }, + "schedule": { + "$ref": "#/definitions/JobRecurrenceSchedule" + } + } + }, + "RecurrenceFrequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "JobRecurrenceSchedule": { + "properties": { + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "description": "Gets or sets the days of the week that the job should execute on." + }, + "hours": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the hours of the day that the job should execute at." + }, + "minutes": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the minutes of the hour that the job should execute at." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the days of the month that the job should execute on. Must be between 1 and 31." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/JobRecurrenceScheduleMonthlyOccurrence" + }, + "description": "Gets or sets the occurrences of days within a month." + } + } + }, + "JobRecurrenceScheduleMonthlyOccurrence": { + "properties": { + "day": { + "type": "string", + "description": "Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "JobScheduleDay", + "modelAsString": false + } + }, + "Occurrence": { + "type": "integer", + "description": "Gets or sets the occurrence. Must be between -5 and 5." + } + } + }, + "JobStateFilter": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/JobState", + "description": "Gets or sets the job state." + } + } + }, + "JobState": { + "type": "string", + "description": "Gets or set the job state.", + "enum": [ + "Enabled", + "Disabled", + "Faulted", + "Completed" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false + } + }, + "JobHistoryFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/JobExecutionStatus", + "description": "Gets or sets the job execution status." + } + } + }, + "JobExecutionStatus": { + "type": "string", + "description": "Gets the job execution status.", + "enum": [ + "Completed", + "Failed", + "Postponed" + ], + "x-ms-enum": { + "name": "JobExecutionStatus", + "modelAsString": false + } + }, + "JobStatus": { + "properties": { + "executionCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of times this job has executed." + }, + "failureCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of times this job has failed." + }, + "faultedCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states)." + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet." + }, + "nextExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed." + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "description": "The subscription id.", + "in": "path", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "description": "The API version.", + "in": "query", + "required": true, + "type": "string" + } + } +} diff --git a/arm-scheduler/2016-01-01/swagger/scheduler.json b/arm-scheduler/2016-01-01/swagger/scheduler.json index 17527fd7839e..7f82baf283a3 100644 --- a/arm-scheduler/2016-01-01/swagger/scheduler.json +++ b/arm-scheduler/2016-01-01/swagger/scheduler.json @@ -1,1624 +1,1624 @@ -{ - "swagger": "2.0", - "info": { - "title": "SchedulerManagementClient", - "version": "2016-01-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_ListBySubscription", - "description": "Gets all job collections under specified subscription.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collections have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_ListByResourceGroup", - "description": "Gets all job collections under specified resource group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collections have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}": { - "get": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Get", - "description": "Gets a job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "put": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_CreateOrUpdate", - "description": "Provisions a new job collection or updates an existing job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "jobCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "The job collection definition." - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully updated.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - }, - "201": { - "description": "The job collection has been successfully created.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "patch": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Patch", - "description": "Patches an existing job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "jobCollection", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "The job collection definition." - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully patched.", - "schema": { - "$ref": "#/definitions/JobCollectionDefinition" - } - } - } - }, - "delete": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Delete", - "description": "Deletes a job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job collection has been successfully deleted." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable": { - "post": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Enable", - "description": "Enables all of the jobs in the job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "All of the jobs in the job collection have been successfully enabled." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable": { - "post": { - "tags": [ - "JobCollections" - ], - "operationId": "JobCollections_Disable", - "description": "Disables all of the jobs in the job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "All of the jobs in the job collection have been successfully disabled." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Get", - "description": "Gets a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "put": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_CreateOrUpdate", - "description": "Provisions a new job or updates an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "The job definition." - } - ], - "responses": { - "200": { - "description": "The job has been successfully updated.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - }, - "201": { - "description": "The job has been successfully created.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "patch": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Patch", - "description": "Patches an existing job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "job", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "The job definition." - } - ], - "responses": { - "200": { - "description": "The job has been successfully patched.", - "schema": { - "$ref": "#/definitions/JobDefinition" - } - } - } - }, - "delete": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Delete", - "description": "Deletes a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully deleted." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run": { - "post": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_Run", - "description": "Runs a job.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The job has been successfully run." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_List", - "description": "Lists all jobs under the specified job collection.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "description": "The number of jobs to request, in the of range [1..100]." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "The (0-based) index of the job history list from which to begin requesting entries." - }, - { - "name": "$filter", - "description": "The filter to apply on the job state.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The job has been successfully returned.", - "schema": { - "$ref": "#/definitions/JobListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/JobStateFilter" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history": { - "get": { - "tags": [ - "Jobs" - ], - "operationId": "Jobs_ListJobHistory", - "description": "Lists job history.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The resource group name." - }, - { - "name": "jobCollectionName", - "in": "path", - "required": true, - "type": "string", - "description": "The job collection name." - }, - { - "name": "jobName", - "in": "path", - "required": true, - "type": "string", - "description": "The job name." - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "description": "the number of job history to request, in the of range [1..100]." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "The (0-based) index of the job history list from which to begin requesting entries." - }, - { - "name": "$filter", - "description": "The filter to apply on the job state.", - "in": "query", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The job histories have been successfully returned.", - "schema": { - "$ref": "#/definitions/JobHistoryListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/JobHistoryFilter" - } - } - }, - "definitions": { - "JobCollectionListResult": { - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobCollectionDefinition" - }, - "description": "Gets the job collections." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of job collections." - } - } - }, - "JobListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobDefinition" - }, - "description": "Gets or sets all jobs under job collection." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of jobs." - } - } - }, - "JobHistoryListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/JobHistoryDefinition" - }, - "description": "Gets or sets the job histories under job." - }, - "nextLink": { - "type": "string", - "description": "Gets or sets the URL to get the next set of job histories." - } - } - }, - "JobCollectionDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job collection resource identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job collection resource type." - }, - "name": { - "type": "string", - "description": "Gets or sets the job collection resource name." - }, - "location": { - "type": "string", - "description": "Gets or sets the storage account location." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the tags." - }, - "properties": { - "$ref": "#/definitions/JobCollectionProperties", - "description": "Gets or sets the job collection properties." - } - } - }, - "JobCollectionProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU." - }, - "state": { - "type": "string", - "description": "Gets or sets the state.", - "enum": [ - "Enabled", - "Disabled", - "Suspended", - "Deleted" - ], - "x-ms-enum": { - "name": "JobCollectionState", - "modelAsString": false - } - }, - "quota": { - "$ref": "#/definitions/JobCollectionQuota", - "description": "Gets or sets the job collection quota." - } - } - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "Gets or set the SKU.", - "enum": [ - "Standard", - "Free", - "Premium" - ], - "x-ms-enum": { - "name": "SkuDefinition", - "modelAsString": false - } - } - } - }, - "JobCollectionQuota": { - "properties": { - "maxJobCount": { - "type": "integer", - "description": "Gets or set the maximum job count." - }, - "maxJobOccurrence": { - "type": "integer", - "description": "Gets or sets the maximum job occurrence." - }, - "maxRecurrence": { - "$ref": "#/definitions/JobMaxRecurrence", - "description": "Gets or set the maximum recurrence." - } - } - }, - "JobDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the job resource name." - }, - "properties": { - "$ref": "#/definitions/JobProperties", - "description": "Gets or sets the job properties." - } - } - }, - "JobProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the job start time." - }, - "action": { - "$ref": "#/definitions/JobAction", - "description": "Gets or sets the job action." - }, - "recurrence": { - "$ref": "#/definitions/JobRecurrence", - "description": "Gets or sets the job recurrence." - }, - "state": { - "$ref": "#/definitions/JobState", - "description": "Gets or set the job state." - }, - "status": { - "$ref": "#/definitions/JobStatus", - "readOnly": true, - "description": "Gets the job status." - } - } - }, - "JobHistoryDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Gets the job history identifier." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Gets the job history resource type." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Gets the job history name." - }, - "properties": { - "$ref": "#/definitions/JobHistoryDefinitionProperties", - "readOnly": true, - "description": "Gets or sets the job history properties." - } - } - }, - "JobHistoryDefinitionProperties": { - "properties": { - "startTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the start time for this job." - }, - "endTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the end time for this job." - }, - "expectedExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the expected execution time for this job." - }, - "actionName": { - "type": "string", - "readOnly": true, - "description": "Gets the job history action name.", - "enum": [ - "MainAction", - "ErrorAction" - ], - "x-ms-enum": { - "name": "JobHistoryActionName", - "modelAsString": false - } - }, - "status": { - "$ref": "#/definitions/JobExecutionStatus", - "readOnly": true, - "description": "Gets the job history status." - }, - "message": { - "type": "string", - "readOnly": true, - "description": "Gets the message for the job history." - }, - "retryCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the retry count for job." - }, - "repeatCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the repeat count for the job." - } - } - }, - "JobAction": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the job action type.", - "enum": [ - "Http", - "Https", - "StorageQueue", - "ServiceBusQueue", - "ServiceBusTopic" - ], - "x-ms-enum": { - "name": "JobActionType", - "modelAsString": false - } - }, - "request": { - "$ref": "#/definitions/HttpRequest", - "description": "Gets or sets the http requests." - }, - "queueMessage": { - "$ref": "#/definitions/StorageQueueMessage", - "description": "Gets or sets the storage queue message." - }, - "serviceBusQueueMessage": { - "$ref": "#/definitions/ServiceBusQueueMessage", - "description": "Gets or sets the service bus queue message." - }, - "serviceBusTopicMessage": { - "$ref": "#/definitions/ServiceBusTopicMessage", - "description": "Gets or sets the service bus topic message." - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Gets or sets the retry policy." - }, - "errorAction": { - "$ref": "#/definitions/JobErrorAction", - "description": "Gets or sets the error action." - } - } - }, - "JobErrorAction": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the job error action type.", - "enum": [ - "Http", - "Https", - "StorageQueue", - "ServiceBusQueue", - "ServiceBusTopic" - ], - "x-ms-enum": { - "name": "JobActionType", - "modelAsString": false - } - }, - "request": { - "$ref": "#/definitions/HttpRequest", - "description": "Gets or sets the http requests." - }, - "queueMessage": { - "$ref": "#/definitions/StorageQueueMessage", - "description": "Gets or sets the storage queue message." - }, - "serviceBusQueueMessage": { - "$ref": "#/definitions/ServiceBusQueueMessage", - "description": "Gets or sets the service bus queue message." - }, - "serviceBusTopicMessage": { - "$ref": "#/definitions/ServiceBusTopicMessage", - "description": "Gets or sets the service bus topic message." - }, - "retryPolicy": { - "$ref": "#/definitions/RetryPolicy", - "description": "Gets or sets the retry policy." - } - } - }, - "HttpRequest": { - "properties": { - "authentication": { - "$ref": "#/definitions/HttpAuthentication", - "description": "Gets or sets the http authentication." - }, - "uri": { - "type": "string", - "description": "Gets or sets the Uri." - }, - "method": { - "type": "string", - "description": "Gets or sets the method of the request." - }, - "body": { - "type": "string", - "description": "Gets or sets the request body." - }, - "headers": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the headers." - } - } - }, - "ClientCertAuthentication": { - "properties": { - "password": { - "type": "string", - "description": "Gets or sets the password." - }, - "pfx": { - "type": "string", - "description": "Gets or sets the pfx." - }, - "certificateThumbprint": { - "type": "string", - "description": "Gets or sets the certificate thumbprint." - }, - "certificateExpirationDate": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the certificate expiration date." - }, - "certificateSubjectName": { - "type": "string", - "description": "Gets or sets the certificate subject name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "BasicAuthentication": { - "properties": { - "username": { - "type": "string", - "description": "Gets or sets the username." - }, - "password": { - "type": "string", - "description": "Gets or sets the password." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "OAuthAuthentication": { - "properties": { - "secret": { - "type": "string", - "description": "Gets or sets the secret." - }, - "tenant": { - "type": "string", - "description": "Gets or sets the tenant." - }, - "audience": { - "type": "string", - "description": "Gets or sets the audience." - }, - "clientId": { - "type": "string", - "description": "Gets or sets the client identifier." - } - }, - "allOf": [ - { - "$ref": "#/definitions/HttpAuthentication" - } - ] - }, - "HttpAuthentication": { - "properties": { - "type": { - "type": "string", - "description": "Gets or sets the http authentication type.", - "enum": [ - "NotSpecified", - "ClientCertificate", - "ActiveDirectoryOAuth", - "Basic" - ], - "x-ms-enum": { - "name": "HttpAuthenticationType", - "modelAsString": false - } - } - } - }, - "StorageQueueMessage": { - "properties": { - "storageAccount": { - "type": "string", - "description": "Gets or sets the storage account name." - }, - "queueName": { - "type": "string", - "description": "Gets or sets the queue name." - }, - "sasToken": { - "type": "string", - "description": "Gets or sets the SAS key." - }, - "message": { - "type": "string", - "description": "Gets or sets the message." - } - } - }, - "ServiceBusQueueMessage": { - "properties": { - "queueName": { - "type": "string", - "description": "Gets or sets the queue name." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ServiceBusMessage" - } - ] - }, - "ServiceBusTopicMessage": { - "properties": { - "topicPath": { - "type": "string", - "description": "Gets or sets the topic path." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ServiceBusMessage" - } - ] - }, - "ServiceBusMessage": { - "properties": { - "authentication": { - "$ref": "#/definitions/ServiceBusAuthentication", - "description": "Gets or sets the authentication." - }, - "brokeredMessageProperties": { - "$ref": "#/definitions/ServiceBusBrokeredMessageProperties", - "description": "Gets or sets the brokered message properties." - }, - "customMessageProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets the custom message properties." - }, - "message": { - "type": "string", - "description": "Gets or sets the message." - }, - "namespace": { - "type": "string", - "description": "Gets or sets the namespace." - }, - "transportType": { - "type": "string", - "description": "Gets or sets the transport type.", - "enum": [ - "NotSpecified", - "NetMessaging", - "AMQP" - ], - "x-ms-enum": { - "name": "ServiceBusTransportType", - "modelAsString": false - } - } - } - }, - "ServiceBusAuthentication": { - "properties": { - "sasKey": { - "type": "string", - "description": "Gets or sets the SAS key." - }, - "sasKeyName": { - "type": "string", - "description": "Gets or sets the SAS key name." - }, - "type": { - "type": "string", - "description": "Gets or sets the authentication type.", - "enum": [ - "NotSpecified", - "SharedAccessKey" - ], - "x-ms-enum": { - "name": "ServiceBusAuthenticationType", - "modelAsString": false - } - } - } - }, - "ServiceBusBrokeredMessageProperties": { - "properties": { - "contentType": { - "type": "string", - "description": "Gets or sets the content type." - }, - "correlationId": { - "type": "string", - "description": "Gets or sets the correlation id." - }, - "forcePersistence": { - "type": "boolean", - "description": "Gets or sets the force persistence." - }, - "label": { - "type": "string", - "description": "Gets or sets the label." - }, - "messageId": { - "type": "string", - "description": "Gets or sets the message id." - }, - "partitionKey": { - "type": "string", - "description": "Gets or sets the partition key." - }, - "replyTo": { - "type": "string", - "description": "Gets or sets the reply to." - }, - "replyToSessionId": { - "type": "string", - "description": "Gets or sets the reply to session id." - }, - "scheduledEnqueueTimeUtc": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the scheduled enqueue time UTC." - }, - "sessionId": { - "type": "string", - "description": "Gets or sets the session id." - }, - "timeToLive": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the time to live." - }, - "to": { - "type": "string", - "description": "Gets or sets the to." - }, - "viaPartitionKey": { - "type": "string", - "description": "Gets or sets the via partition key." - } - } - }, - "RetryPolicy": { - "properties": { - "retryType": { - "type": "string", - "description": "Gets or sets the retry strategy to be used.", - "enum": [ - "None", - "Fixed" - ], - "x-ms-enum": { - "name": "RetryType", - "modelAsString": false - } - }, - "retryInterval": { - "type": "string", - "format": "duration", - "description": "Gets or sets the retry interval between retries." - }, - "retryCount": { - "type": "integer", - "description": "Gets or sets the number of times a retry should be attempted." - } - } - }, - "JobMaxRecurrence": { - "properties": { - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval between retries." - } - } - }, - "JobRecurrence": { - "properties": { - "frequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "interval": { - "type": "integer", - "description": "Gets or sets the interval between retries." - }, - "count": { - "type": "integer", - "description": "Gets or sets the maximum number of times that the job should run." - }, - "endTime": { - "type": "string", - "format": "date-time", - "description": "Gets or sets the time at which the job will complete." - }, - "schedule": { - "$ref": "#/definitions/JobRecurrenceSchedule" - } - } - }, - "RecurrenceFrequency": { - "type": "string", - "description": "Gets or sets the frequency of recurrence (minute, hour, day, week, month).", - "enum": [ - "Minute", - "Hour", - "Day", - "Week", - "Month" - ], - "x-ms-enum": { - "name": "RecurrenceFrequency", - "modelAsString": false - } - }, - "JobRecurrenceSchedule": { - "properties": { - "weekDays": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "DayOfWeek", - "modelAsString": false - } - }, - "description": "Gets or sets the days of the week that the job should execute on." - }, - "hours": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the hours of the day that the job should execute at." - }, - "minutes": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the minutes of the hour that the job should execute at." - }, - "monthDays": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "Gets or sets the days of the month that the job should execute on. Must be between 1 and 31." - }, - "monthlyOccurrences": { - "type": "array", - "items": { - "$ref": "#/definitions/JobRecurrenceScheduleMonthlyOccurrence" - }, - "description": "Gets or sets the occurrences of days within a month." - } - } - }, - "JobRecurrenceScheduleMonthlyOccurrence": { - "properties": { - "day": { - "type": "string", - "description": "Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", - "enum": [ - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday", - "Sunday" - ], - "x-ms-enum": { - "name": "JobScheduleDay", - "modelAsString": false - } - }, - "Occurrence": { - "type": "integer", - "description": "Gets or sets the occurrence. Must be between -5 and 5." - } - } - }, - "JobStateFilter": { - "type": "object", - "properties": { - "state": { - "$ref": "#/definitions/JobState", - "description": "Gets or sets the job state." - } - } - }, - "JobState": { - "type": "string", - "description": "Gets or set the job state.", - "enum": [ - "Enabled", - "Disabled", - "Faulted", - "Completed" - ], - "x-ms-enum": { - "name": "JobState", - "modelAsString": false - } - }, - "JobHistoryFilter": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/JobExecutionStatus", - "description": "Gets or sets the job execution status." - } - } - }, - "JobExecutionStatus": { - "type": "string", - "description": "Gets the job execution status.", - "enum": [ - "Completed", - "Failed", - "Postponed" - ], - "x-ms-enum": { - "name": "JobExecutionStatus", - "modelAsString": false - } - }, - "JobStatus": { - "properties": { - "executionCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of times this job has executed." - }, - "failureCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of times this job has failed." - }, - "faultedCount": { - "type": "integer", - "readOnly": true, - "description": "Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states)." - }, - "lastExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet." - }, - "nextExecutionTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed." - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "description": "The subscription id.", - "in": "path", - "required": true, - "type": "string" - }, - "api-version": { - "name": "api-version", - "description": "The API version.", - "in": "query", - "required": true, - "type": "string" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "SchedulerManagementClient", + "version": "2016-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Scheduler/jobCollections": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_ListBySubscription", + "description": "Gets all job collections under specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collections have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_ListByResourceGroup", + "description": "Gets all job collections under specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collections have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}": { + "get": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Get", + "description": "Gets a job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "put": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_CreateOrUpdate", + "description": "Provisions a new job collection or updates an existing job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "jobCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "The job collection definition." + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully updated.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + }, + "201": { + "description": "The job collection has been successfully created.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "patch": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Patch", + "description": "Patches an existing job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "jobCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "The job collection definition." + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully patched.", + "schema": { + "$ref": "#/definitions/JobCollectionDefinition" + } + } + } + }, + "delete": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Delete", + "description": "Deletes a job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job collection has been successfully deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/enable": { + "post": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Enable", + "description": "Enables all of the jobs in the job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "All of the jobs in the job collection have been successfully enabled." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/disable": { + "post": { + "tags": [ + "JobCollections" + ], + "operationId": "JobCollections_Disable", + "description": "Disables all of the jobs in the job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "All of the jobs in the job collection have been successfully disabled." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Get", + "description": "Gets a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_CreateOrUpdate", + "description": "Provisions a new job or updates an existing job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "job", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "The job definition." + } + ], + "responses": { + "200": { + "description": "The job has been successfully updated.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + }, + "201": { + "description": "The job has been successfully created.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Patch", + "description": "Patches an existing job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "job", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "The job definition." + } + ], + "responses": { + "200": { + "description": "The job has been successfully patched.", + "schema": { + "$ref": "#/definitions/JobDefinition" + } + } + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Delete", + "description": "Deletes a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully deleted." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Run", + "description": "Runs a job.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The job has been successfully run." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_List", + "description": "Lists all jobs under the specified job collection.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "The number of jobs to request, in the of range [1..100]." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The (0-based) index of the job history list from which to begin requesting entries." + }, + { + "name": "$filter", + "description": "The filter to apply on the job state.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The job has been successfully returned.", + "schema": { + "$ref": "#/definitions/JobListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobStateFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_ListJobHistory", + "description": "Lists job history.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "jobCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The job collection name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The job name." + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "the number of job history to request, in the of range [1..100]." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "description": "The (0-based) index of the job history list from which to begin requesting entries." + }, + { + "name": "$filter", + "description": "The filter to apply on the job state.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The job histories have been successfully returned.", + "schema": { + "$ref": "#/definitions/JobHistoryListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobHistoryFilter" + } + } + }, + "definitions": { + "JobCollectionListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobCollectionDefinition" + }, + "description": "Gets the job collections." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of job collections." + } + } + }, + "JobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobDefinition" + }, + "description": "Gets or sets all jobs under job collection." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of jobs." + } + } + }, + "JobHistoryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobHistoryDefinition" + }, + "description": "Gets or sets the job histories under job." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the URL to get the next set of job histories." + } + } + }, + "JobCollectionDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job collection resource identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job collection resource type." + }, + "name": { + "type": "string", + "description": "Gets or sets the job collection resource name." + }, + "location": { + "type": "string", + "description": "Gets or sets the storage account location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the tags." + }, + "properties": { + "$ref": "#/definitions/JobCollectionProperties", + "description": "Gets or sets the job collection properties." + } + } + }, + "JobCollectionProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU." + }, + "state": { + "type": "string", + "description": "Gets or sets the state.", + "enum": [ + "Enabled", + "Disabled", + "Suspended", + "Deleted" + ], + "x-ms-enum": { + "name": "JobCollectionState", + "modelAsString": false + } + }, + "quota": { + "$ref": "#/definitions/JobCollectionQuota", + "description": "Gets or sets the job collection quota." + } + } + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or set the SKU.", + "enum": [ + "Standard", + "Free", + "Premium" + ], + "x-ms-enum": { + "name": "SkuDefinition", + "modelAsString": false + } + } + } + }, + "JobCollectionQuota": { + "properties": { + "maxJobCount": { + "type": "integer", + "description": "Gets or set the maximum job count." + }, + "maxJobOccurrence": { + "type": "integer", + "description": "Gets or sets the maximum job occurrence." + }, + "maxRecurrence": { + "$ref": "#/definitions/JobMaxRecurrence", + "description": "Gets or set the maximum recurrence." + } + } + }, + "JobDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource type." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the job resource name." + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Gets or sets the job properties." + } + } + }, + "JobProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the job start time." + }, + "action": { + "$ref": "#/definitions/JobAction", + "description": "Gets or sets the job action." + }, + "recurrence": { + "$ref": "#/definitions/JobRecurrence", + "description": "Gets or sets the job recurrence." + }, + "state": { + "$ref": "#/definitions/JobState", + "description": "Gets or set the job state." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "readOnly": true, + "description": "Gets the job status." + } + } + }, + "JobHistoryDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Gets the job history identifier." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the job history resource type." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the job history name." + }, + "properties": { + "$ref": "#/definitions/JobHistoryDefinitionProperties", + "readOnly": true, + "description": "Gets or sets the job history properties." + } + } + }, + "JobHistoryDefinitionProperties": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the start time for this job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the end time for this job." + }, + "expectedExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the expected execution time for this job." + }, + "actionName": { + "type": "string", + "readOnly": true, + "description": "Gets the job history action name.", + "enum": [ + "MainAction", + "ErrorAction" + ], + "x-ms-enum": { + "name": "JobHistoryActionName", + "modelAsString": false + } + }, + "status": { + "$ref": "#/definitions/JobExecutionStatus", + "readOnly": true, + "description": "Gets the job history status." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Gets the message for the job history." + }, + "retryCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the retry count for job." + }, + "repeatCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the repeat count for the job." + } + } + }, + "JobAction": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the job action type.", + "enum": [ + "Http", + "Https", + "StorageQueue", + "ServiceBusQueue", + "ServiceBusTopic" + ], + "x-ms-enum": { + "name": "JobActionType", + "modelAsString": false + } + }, + "request": { + "$ref": "#/definitions/HttpRequest", + "description": "Gets or sets the http requests." + }, + "queueMessage": { + "$ref": "#/definitions/StorageQueueMessage", + "description": "Gets or sets the storage queue message." + }, + "serviceBusQueueMessage": { + "$ref": "#/definitions/ServiceBusQueueMessage", + "description": "Gets or sets the service bus queue message." + }, + "serviceBusTopicMessage": { + "$ref": "#/definitions/ServiceBusTopicMessage", + "description": "Gets or sets the service bus topic message." + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Gets or sets the retry policy." + }, + "errorAction": { + "$ref": "#/definitions/JobErrorAction", + "description": "Gets or sets the error action." + } + } + }, + "JobErrorAction": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the job error action type.", + "enum": [ + "Http", + "Https", + "StorageQueue", + "ServiceBusQueue", + "ServiceBusTopic" + ], + "x-ms-enum": { + "name": "JobActionType", + "modelAsString": false + } + }, + "request": { + "$ref": "#/definitions/HttpRequest", + "description": "Gets or sets the http requests." + }, + "queueMessage": { + "$ref": "#/definitions/StorageQueueMessage", + "description": "Gets or sets the storage queue message." + }, + "serviceBusQueueMessage": { + "$ref": "#/definitions/ServiceBusQueueMessage", + "description": "Gets or sets the service bus queue message." + }, + "serviceBusTopicMessage": { + "$ref": "#/definitions/ServiceBusTopicMessage", + "description": "Gets or sets the service bus topic message." + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "Gets or sets the retry policy." + } + } + }, + "HttpRequest": { + "properties": { + "authentication": { + "$ref": "#/definitions/HttpAuthentication", + "description": "Gets or sets the http authentication." + }, + "uri": { + "type": "string", + "description": "Gets or sets the Uri." + }, + "method": { + "type": "string", + "description": "Gets or sets the method of the request." + }, + "body": { + "type": "string", + "description": "Gets or sets the request body." + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the headers." + } + } + }, + "ClientCertAuthentication": { + "properties": { + "password": { + "type": "string", + "description": "Gets or sets the password." + }, + "pfx": { + "type": "string", + "description": "Gets or sets the pfx." + }, + "certificateThumbprint": { + "type": "string", + "description": "Gets or sets the certificate thumbprint." + }, + "certificateExpirationDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the certificate expiration date." + }, + "certificateSubjectName": { + "type": "string", + "description": "Gets or sets the certificate subject name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "BasicAuthentication": { + "properties": { + "username": { + "type": "string", + "description": "Gets or sets the username." + }, + "password": { + "type": "string", + "description": "Gets or sets the password." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "OAuthAuthentication": { + "properties": { + "secret": { + "type": "string", + "description": "Gets or sets the secret." + }, + "tenant": { + "type": "string", + "description": "Gets or sets the tenant." + }, + "audience": { + "type": "string", + "description": "Gets or sets the audience." + }, + "clientId": { + "type": "string", + "description": "Gets or sets the client identifier." + } + }, + "allOf": [ + { + "$ref": "#/definitions/HttpAuthentication" + } + ] + }, + "HttpAuthentication": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the http authentication type.", + "enum": [ + "NotSpecified", + "ClientCertificate", + "ActiveDirectoryOAuth", + "Basic" + ], + "x-ms-enum": { + "name": "HttpAuthenticationType", + "modelAsString": false + } + } + } + }, + "StorageQueueMessage": { + "properties": { + "storageAccount": { + "type": "string", + "description": "Gets or sets the storage account name." + }, + "queueName": { + "type": "string", + "description": "Gets or sets the queue name." + }, + "sasToken": { + "type": "string", + "description": "Gets or sets the SAS key." + }, + "message": { + "type": "string", + "description": "Gets or sets the message." + } + } + }, + "ServiceBusQueueMessage": { + "properties": { + "queueName": { + "type": "string", + "description": "Gets or sets the queue name." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServiceBusMessage" + } + ] + }, + "ServiceBusTopicMessage": { + "properties": { + "topicPath": { + "type": "string", + "description": "Gets or sets the topic path." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ServiceBusMessage" + } + ] + }, + "ServiceBusMessage": { + "properties": { + "authentication": { + "$ref": "#/definitions/ServiceBusAuthentication", + "description": "Gets or sets the authentication." + }, + "brokeredMessageProperties": { + "$ref": "#/definitions/ServiceBusBrokeredMessageProperties", + "description": "Gets or sets the brokered message properties." + }, + "customMessageProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the custom message properties." + }, + "message": { + "type": "string", + "description": "Gets or sets the message." + }, + "namespace": { + "type": "string", + "description": "Gets or sets the namespace." + }, + "transportType": { + "type": "string", + "description": "Gets or sets the transport type.", + "enum": [ + "NotSpecified", + "NetMessaging", + "AMQP" + ], + "x-ms-enum": { + "name": "ServiceBusTransportType", + "modelAsString": false + } + } + } + }, + "ServiceBusAuthentication": { + "properties": { + "sasKey": { + "type": "string", + "description": "Gets or sets the SAS key." + }, + "sasKeyName": { + "type": "string", + "description": "Gets or sets the SAS key name." + }, + "type": { + "type": "string", + "description": "Gets or sets the authentication type.", + "enum": [ + "NotSpecified", + "SharedAccessKey" + ], + "x-ms-enum": { + "name": "ServiceBusAuthenticationType", + "modelAsString": false + } + } + } + }, + "ServiceBusBrokeredMessageProperties": { + "properties": { + "contentType": { + "type": "string", + "description": "Gets or sets the content type." + }, + "correlationId": { + "type": "string", + "description": "Gets or sets the correlation id." + }, + "forcePersistence": { + "type": "boolean", + "description": "Gets or sets the force persistence." + }, + "label": { + "type": "string", + "description": "Gets or sets the label." + }, + "messageId": { + "type": "string", + "description": "Gets or sets the message id." + }, + "partitionKey": { + "type": "string", + "description": "Gets or sets the partition key." + }, + "replyTo": { + "type": "string", + "description": "Gets or sets the reply to." + }, + "replyToSessionId": { + "type": "string", + "description": "Gets or sets the reply to session id." + }, + "scheduledEnqueueTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the scheduled enqueue time UTC." + }, + "sessionId": { + "type": "string", + "description": "Gets or sets the session id." + }, + "timeToLive": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time to live." + }, + "to": { + "type": "string", + "description": "Gets or sets the to." + }, + "viaPartitionKey": { + "type": "string", + "description": "Gets or sets the via partition key." + } + } + }, + "RetryPolicy": { + "properties": { + "retryType": { + "type": "string", + "description": "Gets or sets the retry strategy to be used.", + "enum": [ + "None", + "Fixed" + ], + "x-ms-enum": { + "name": "RetryType", + "modelAsString": false + } + }, + "retryInterval": { + "type": "string", + "format": "duration", + "description": "Gets or sets the retry interval between retries." + }, + "retryCount": { + "type": "integer", + "description": "Gets or sets the number of times a retry should be attempted." + } + } + }, + "JobMaxRecurrence": { + "properties": { + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval between retries." + } + } + }, + "JobRecurrence": { + "properties": { + "frequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (second, minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "interval": { + "type": "integer", + "description": "Gets or sets the interval between retries." + }, + "count": { + "type": "integer", + "description": "Gets or sets the maximum number of times that the job should run." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time at which the job will complete." + }, + "schedule": { + "$ref": "#/definitions/JobRecurrenceSchedule" + } + } + }, + "RecurrenceFrequency": { + "type": "string", + "description": "Gets or sets the frequency of recurrence (minute, hour, day, week, month).", + "enum": [ + "Minute", + "Hour", + "Day", + "Week", + "Month" + ], + "x-ms-enum": { + "name": "RecurrenceFrequency", + "modelAsString": false + } + }, + "JobRecurrenceSchedule": { + "properties": { + "weekDays": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "description": "Gets or sets the days of the week that the job should execute on." + }, + "hours": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the hours of the day that the job should execute at." + }, + "minutes": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the minutes of the hour that the job should execute at." + }, + "monthDays": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Gets or sets the days of the month that the job should execute on. Must be between 1 and 31." + }, + "monthlyOccurrences": { + "type": "array", + "items": { + "$ref": "#/definitions/JobRecurrenceScheduleMonthlyOccurrence" + }, + "description": "Gets or sets the occurrences of days within a month." + } + } + }, + "JobRecurrenceScheduleMonthlyOccurrence": { + "properties": { + "day": { + "type": "string", + "description": "Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "JobScheduleDay", + "modelAsString": false + } + }, + "Occurrence": { + "type": "integer", + "description": "Gets or sets the occurrence. Must be between -5 and 5." + } + } + }, + "JobStateFilter": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/JobState", + "description": "Gets or sets the job state." + } + } + }, + "JobState": { + "type": "string", + "description": "Gets or set the job state.", + "enum": [ + "Enabled", + "Disabled", + "Faulted", + "Completed" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false + } + }, + "JobHistoryFilter": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/JobExecutionStatus", + "description": "Gets or sets the job execution status." + } + } + }, + "JobExecutionStatus": { + "type": "string", + "description": "Gets the job execution status.", + "enum": [ + "Completed", + "Failed", + "Postponed" + ], + "x-ms-enum": { + "name": "JobExecutionStatus", + "modelAsString": false + } + }, + "JobStatus": { + "properties": { + "executionCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of times this job has executed." + }, + "failureCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of times this job has failed." + }, + "faultedCount": { + "type": "integer", + "readOnly": true, + "description": "Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states)." + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet." + }, + "nextExecutionTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed." + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "description": "The subscription id.", + "in": "path", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "description": "The API version.", + "in": "query", + "required": true, + "type": "string" + } + } +} diff --git a/arm-search/2015-02-28/swagger/search.json b/arm-search/2015-02-28/swagger/search.json index 07c3c7dcd550..53ebc9b0caa2 100644 --- a/arm-search/2015-02-28/swagger/search.json +++ b/arm-search/2015-02-28/swagger/search.json @@ -1,508 +1,508 @@ -{ - "swagger": "2.0", - "info": { - "title": "SearchManagementClient", - "description": "Client that can be used to manage Azure Search services and API keys.", - "version": "2015-02-28" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listAdminKeys": { - "post": { - "tags": [ - "AdminKeys" - ], - "operationId": "AdminKeys_List", - "description": "Returns the primary and secondary API keys for the given Azure Search service.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832685.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Search service for which to list admin keys." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/AdminKeyResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listQueryKeys": { - "get": { - "tags": [ - "QueryKeys" - ], - "operationId": "QueryKeys_List", - "description": "Returns the list of query API keys for the given Azure Search service.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832701.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Search service for which to list query keys." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/ListQueryKeysResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}": { - "put": { - "tags": [ - "Services" - ], - "operationId": "Services_CreateOrUpdate", - "description": "Creates or updates a Search service in the given resource group. If the Search service already exists, all properties will be updated with the given values.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832687.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Search service to create or update." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/SearchServiceCreateOrUpdateParameters" - }, - "description": "The properties to set or update on the Search service." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchServiceResource" - } - }, - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchServiceResource" - } - } - } - }, - "delete": { - "tags": [ - "Services" - ], - "operationId": "Services_Delete", - "description": "Deletes a Search service in the given resource group, along with its associated resources.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832692.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "name": "serviceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Search service to delete." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "404": { - "description": "" - }, - "204": { - "description": "" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices": { - "get": { - "tags": [ - "Services" - ], - "operationId": "Services_List", - "description": "Returns a list of all Search services in the given resource group.", - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn832688.aspx" - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the current subscription." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/SearchServiceListResult" - } - } - } - } - } - }, - "definitions": { - "AdminKeyResult": { - "properties": { - "primaryKey": { - "type": "string", - "description": "Gets the primary API key of the Search service." - }, - "secondaryKey": { - "type": "string", - "description": "Gets the secondary API key of the Search service." - } - }, - "description": "Response containing the primary and secondary API keys for a given Azure Search service." - }, - "QueryKey": { - "properties": { - "name": { - "type": "string", - "description": "Gets the name of the query API key; may be empty." - }, - "key": { - "type": "string", - "description": "Gets the value of the query API key." - } - }, - "description": "Describes an API key for a given Azure Search service that has permissions for query operations only." - }, - "ListQueryKeysResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/QueryKey" - }, - "description": "Gets the query keys for the Azure Search service." - } - }, - "description": "Response containing the query API keys for a given Azure Search service." - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the SKU of the Search service.", - "enum": [ - "free", - "standard", - "standard2" - ], - "x-ms-enum": { - "name": "SkuType" - } - } - }, - "description": "Defines the SKU of an Azure Search Service, which determines price tier and capacity limits." - }, - "SearchServiceProperties": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU of the Search Service, which determines price tier and capacity limits." - }, - "replicaCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive." - }, - "partitionCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12." - } - }, - "description": "Defines properties of an Azure Search service that can be modified." - }, - "SearchServiceCreateOrUpdateParameters": { - "properties": { - "location": { - "type": "string", - "description": "Gets or sets the geographic location of the Search service." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets tags to help categorize the Search service in the Azure Portal." - }, - "properties": { - "$ref": "#/definitions/SearchServiceProperties", - "description": "Gets or sets properties of the Search service." - } - }, - "description": "Properties that describe an Azure Search service." - }, - "SearchServiceReadableProperties": { - "properties": { - "status": { - "type": "string", - "description": "Gets the status of the Search service.", - "enum": [ - "running", - "provisioning", - "deleting", - "degraded", - "disabled", - "error" - ], - "x-ms-enum": { - "name": "SearchServiceStatus" - } - }, - "statusDetails": { - "type": "string", - "description": "Gets the details of the Search service status." - }, - "provisioningState": { - "type": "string", - "description": "Gets the state of the last provisioning operation performed on the Search service.", - "enum": [ - "succeeded", - "provisioning", - "failed" - ], - "x-ms-enum": { - "name": "ProvisioningState" - } - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU of the Search Service, which determines price tier and capacity limits." - }, - "replicaCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive." - }, - "partitionCount": { - "type": "integer", - "format": "int32", - "description": "Gets or sets the number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12." - } - }, - "description": "Defines all the properties of an Azure Search service." - }, - "SearchServiceResource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "externalDocs": { - "url": "https://msdn.microsoft.com/library/azure/dn857353.aspx" - }, - "type": "string", - "description": "Gets or sets the name of the Search service." - }, - "location": { - "type": "string", - "description": "Gets or sets the geographic location of the Search service." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Gets or sets tags to help categorize the Search service in the Azure Portal." - }, - "properties": { - "$ref": "#/definitions/SearchServiceReadableProperties", - "description": "Gets properties of the Search service." - } - }, - "description": "Describes an Azure Search service and its current state." - }, - "SearchServiceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SearchServiceResource" - }, - "description": "Gets the Search services in the resource group." - } - }, - "description": "Response containing a list of Azure Search services for a given resource group." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-external": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-external": true - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "SearchManagementClient", + "description": "Client that can be used to manage Azure Search services and API keys.", + "version": "2015-02-28" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listAdminKeys": { + "post": { + "tags": [ + "AdminKeys" + ], + "operationId": "AdminKeys_List", + "description": "Returns the primary and secondary API keys for the given Azure Search service.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832685.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Search service for which to list admin keys." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AdminKeyResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}/listQueryKeys": { + "get": { + "tags": [ + "QueryKeys" + ], + "operationId": "QueryKeys_List", + "description": "Returns the list of query API keys for the given Azure Search service.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832701.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Search service for which to list query keys." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListQueryKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{serviceName}": { + "put": { + "tags": [ + "Services" + ], + "operationId": "Services_CreateOrUpdate", + "description": "Creates or updates a Search service in the given resource group. If the Search service already exists, all properties will be updated with the given values.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832687.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Search service to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchServiceCreateOrUpdateParameters" + }, + "description": "The properties to set or update on the Search service." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchServiceResource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchServiceResource" + } + } + } + }, + "delete": { + "tags": [ + "Services" + ], + "operationId": "Services_Delete", + "description": "Deletes a Search service in the given resource group, along with its associated resources.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832692.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Search service to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "404": { + "description": "" + }, + "204": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices": { + "get": { + "tags": [ + "Services" + ], + "operationId": "Services_List", + "description": "Returns a list of all Search services in the given resource group.", + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn832688.aspx" + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the current subscription." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchServiceListResult" + } + } + } + } + } + }, + "definitions": { + "AdminKeyResult": { + "properties": { + "primaryKey": { + "type": "string", + "description": "Gets the primary API key of the Search service." + }, + "secondaryKey": { + "type": "string", + "description": "Gets the secondary API key of the Search service." + } + }, + "description": "Response containing the primary and secondary API keys for a given Azure Search service." + }, + "QueryKey": { + "properties": { + "name": { + "type": "string", + "description": "Gets the name of the query API key; may be empty." + }, + "key": { + "type": "string", + "description": "Gets the value of the query API key." + } + }, + "description": "Describes an API key for a given Azure Search service that has permissions for query operations only." + }, + "ListQueryKeysResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryKey" + }, + "description": "Gets the query keys for the Azure Search service." + } + }, + "description": "Response containing the query API keys for a given Azure Search service." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the SKU of the Search service.", + "enum": [ + "free", + "standard", + "standard2" + ], + "x-ms-enum": { + "name": "SkuType" + } + } + }, + "description": "Defines the SKU of an Azure Search Service, which determines price tier and capacity limits." + }, + "SearchServiceProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the Search Service, which determines price tier and capacity limits." + }, + "replicaCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive." + }, + "partitionCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12." + } + }, + "description": "Defines properties of an Azure Search service that can be modified." + }, + "SearchServiceCreateOrUpdateParameters": { + "properties": { + "location": { + "type": "string", + "description": "Gets or sets the geographic location of the Search service." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets tags to help categorize the Search service in the Azure Portal." + }, + "properties": { + "$ref": "#/definitions/SearchServiceProperties", + "description": "Gets or sets properties of the Search service." + } + }, + "description": "Properties that describe an Azure Search service." + }, + "SearchServiceReadableProperties": { + "properties": { + "status": { + "type": "string", + "description": "Gets the status of the Search service.", + "enum": [ + "running", + "provisioning", + "deleting", + "degraded", + "disabled", + "error" + ], + "x-ms-enum": { + "name": "SearchServiceStatus" + } + }, + "statusDetails": { + "type": "string", + "description": "Gets the details of the Search service status." + }, + "provisioningState": { + "type": "string", + "description": "Gets the state of the last provisioning operation performed on the Search service.", + "enum": [ + "succeeded", + "provisioning", + "failed" + ], + "x-ms-enum": { + "name": "ProvisioningState" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the Search Service, which determines price tier and capacity limits." + }, + "replicaCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of replicas in the Search service. If specified, it must be a value between 1 and 6 inclusive." + }, + "partitionCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of partitions in the Search service; if specified, it can be 1, 2, 3, 4, 6, or 12." + } + }, + "description": "Defines all the properties of an Azure Search service." + }, + "SearchServiceResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "externalDocs": { + "url": "https://msdn.microsoft.com/library/azure/dn857353.aspx" + }, + "type": "string", + "description": "Gets or sets the name of the Search service." + }, + "location": { + "type": "string", + "description": "Gets or sets the geographic location of the Search service." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets tags to help categorize the Search service in the Azure Portal." + }, + "properties": { + "$ref": "#/definitions/SearchServiceReadableProperties", + "description": "Gets properties of the Search service." + } + }, + "description": "Describes an Azure Search service and its current state." + }, + "SearchServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchServiceResource" + }, + "description": "Gets the Search services in the resource group." + } + }, + "description": "Response containing a list of Azure Search services for a given resource group." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-external": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-external": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/arm-servicefabric/2016-01-28/swagger/servicefabric.json b/arm-servicefabric/2016-01-28/swagger/servicefabric.json index 953bc5e3f170..873d5045a6cd 100644 --- a/arm-servicefabric/2016-01-28/swagger/servicefabric.json +++ b/arm-servicefabric/2016-01-28/swagger/servicefabric.json @@ -1,5146 +1,5146 @@ -{ - "swagger": "2.0", - "info": { - "title": "ServiceFabricClient", - "version": "1.0.0" - }, - "host": "localhost:10710", - "paths": { - "/$/GetClusterManifest": { - "get": { - "operationId": "GetClusterManifest", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The cluster manifest", - "schema": { - "type": "string" - } - } - } - } - }, - "/$/ReportClusterHealth": { - "post": { - "operationId": "SendClusterHealthReport", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "clusterHealthReport", - "in": "body", - "description": "The report of the cluster health", - "required": true, - "schema": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The cluster health report", - "schema": { - "type": "string" - } - } - } - } - }, - "/Nodes": { - "get": { - "operationId": "GetNodeList", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "name": "continuation-token", - "in": "query", - "description": "The token of the continuation", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The node array", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Node" - } - } - } - } - } - }, - "/Nodes/{nodeName}": { - "get": { - "operationId": "GetNode", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "continuation-token", - "in": "query", - "description": "The token of the continuation", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The node", - "schema": { - "$ref": "#/definitions/Node" - } - } - } - } - }, - "/Nodes/{nodeName}/$/Activate": { - "post": { - "operationId": "EnableNode", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The node", - "schema": { - "type": "string" - } - } - } - } - }, - "/Nodes/{nodeName}/$/Deactivate": { - "post": { - "operationId": "DisableNode", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "disableNode", - "in": "body", - "description": "The node of the disable", - "required": true, - "schema": { - "type": "object", - "properties": { - "DeactivationIntent": { - "type": "integer" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The node", - "schema": { - "type": "string" - } - } - } - } - }, - "/Nodes/{nodeName}/$/RemoveNodeState": { - "post": { - "operationId": "RemoveNodeState", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The node state", - "schema": { - "type": "string" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetHealth": { - "get": { - "operationId": "GetNodeHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "EventsHealthStateFilter", - "in": "query", - "description": "The filter of the events health state", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The node health", - "schema": { - "$ref": "#/definitions/NodeHealth" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications": { - "get": { - "operationId": "GetDeployedApplicationList", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed application list", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedApplication" - } - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}": { - "get": { - "operationId": "GetDeployedApplication", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed application", - "schema": { - "$ref": "#/definitions/DeployedApplication" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetHealth": { - "get": { - "operationId": "GetDeployedApplicationHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "EventsHealthStateFilter", - "in": "query", - "description": "The filter of the events health state", - "required": false, - "type": "string" - }, - { - "name": "DeployedServicePackagesHealthStateFilter", - "in": "query", - "description": "The filter of the deployed service packages health state", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed application health", - "schema": { - "$ref": "#/definitions/DeployedApplicationHealth" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetLoadInformation": { - "get": { - "operationId": "GetNodeLoadInformation", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The node load information", - "schema": { - "$ref": "#/definitions/NodeLoadInformation" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetCodePackages": { - "get": { - "operationId": "GetDeployedCodePackage", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed code package", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedCodePackage" - } - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetReplicas": { - "get": { - "operationId": "GetDeployedReplica", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed replica", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedReplica" - } - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetPartitions/{partitionName}/$/GetReplicas/{replicaId}/$/GetDetail": { - "get": { - "operationId": "GetDeployedReplicaDetail", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "partitionName", - "in": "path", - "description": "The name of the partition", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "replicaId", - "in": "path", - "description": "The id of the replica", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed replica detail", - "schema": { - "$ref": "#/definitions/DeployedReplicaDetail" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetServicePackages": { - "get": { - "operationId": "GetDeployedServicePackage", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed service package", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServicePackage" - } - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetServicePackages/{servicePackageName}/$/GetHealth": { - "get": { - "operationId": "GetDeployedServicePackageHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "servicePackageName", - "in": "path", - "description": "The name of the service package", - "type": "string", - "required": true - }, - { - "name": "EventsHealthStateFilter", - "in": "query", - "description": "The filter of the events health state", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed service package health", - "schema": { - "$ref": "#/definitions/DeployedServicePackageHealth" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetServiceTypes": { - "get": { - "operationId": "GetDeployedServiceType", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed service type", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/DeployedServiceType" - } - } - } - } - } - }, - "/Nodes/{nodeName}/$/ReportHealth": { - "post": { - "operationId": "SendNodeHealthReport", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "nodeHealthReport", - "in": "body", - "description": "The report of the node health", - "required": true, - "schema": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The node health report", - "schema": { - "type": "string" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/ReportHealth": { - "post": { - "operationId": "SendDeployedApplicationHealthReport", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "deployedApplicationHealthReport", - "in": "body", - "description": "The report of the deployed application health", - "required": true, - "schema": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed application health report", - "schema": { - "type": "string" - } - } - } - } - }, - "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetServicePackages/{serviceManifestName}/$/ReportHealth": { - "post": { - "operationId": "SendDeployedServicePackageHealthReport", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "nodeName", - "in": "path", - "description": "The name of the node", - "type": "string", - "required": true - }, - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceManifestName", - "in": "path", - "description": "The name of the service manifest", - "type": "string", - "required": true - }, - { - "name": "deployedServicePackageHealthReport", - "in": "body", - "description": "The report of the deployed service package health", - "required": true, - "schema": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The deployed service package health report", - "schema": { - "type": "string" - } - } - } - } - }, - "/ApplicationTypes": { - "get": { - "operationId": "GetApplicationTypeList", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application type", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationType" - } - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}": { - "get": { - "operationId": "GetApplicationType", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationTypeName", - "in": "path", - "description": "The name of the application type", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application type", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationType" - } - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest": { - "get": { - "operationId": "GetServiceManifest", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationTypeName", - "in": "path", - "description": "The name of the application type", - "type": "string", - "required": true - }, - { - "name": "ApplicationTypeVersion", - "in": "query", - "description": "The version of the application type", - "required": true, - "type": "string" - }, - { - "name": "ServiceManifestName", - "in": "query", - "description": "The name of the service manifest", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service manifest", - "schema": { - "$ref": "#/definitions/ServiceManifest" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes": { - "get": { - "operationId": "GetServiceType", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationTypeName", - "in": "path", - "description": "The name of the application type", - "type": "string", - "required": true - }, - { - "name": "ApplicationTypeVersion", - "in": "query", - "description": "The version of the application type", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service type", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceType" - } - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest": { - "get": { - "operationId": "GetApplicationManifest", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationTypeName", - "in": "path", - "description": "The name of the application type", - "type": "string", - "required": true - }, - { - "name": "ApplicationTypeVersion", - "in": "query", - "description": "The version of the application type", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "continuation-token", - "in": "query", - "description": "The token of the continuation", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The application manifest", - "schema": { - "$ref": "#/definitions/ApplicationManifest" - } - } - } - } - }, - "/ApplicationTypes/$/Provision": { - "post": { - "operationId": "RegisterApplicationType", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "RegisterApplicationType", - "in": "body", - "description": "The type of the register application", - "required": true, - "schema": { - "type": "object", - "properties": { - "ApplicationTypeBuildPath": { - "type": "string" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application type", - "schema": { - "type": "string" - } - } - } - } - }, - "/ApplicationTypes/{applicationTypeName}/$/Unprovision": { - "post": { - "operationId": "UnregisterApplicationType", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationTypeName", - "in": "path", - "description": "The name of the application type", - "type": "string", - "required": true - }, - { - "name": "UnregisterApplicationType", - "in": "body", - "description": "The type of the unregister application", - "required": true, - "schema": { - "type": "object", - "properties": { - "ApplicationTypeVersion": { - "type": "string" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application type", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications": { - "get": { - "operationId": "GetApplicationList", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "name": "continuation-token", - "in": "query", - "description": "The token of the continuation", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The application", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Application" - } - } - } - } - } - }, - "/Applications/{applicationName}": { - "get": { - "operationId": "GetApplication", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "continuation-token", - "in": "query", - "description": "The token of the continuation", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "The application", - "schema": { - "$ref": "#/definitions/Application" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServices": { - "get": { - "operationId": "GetServiceList", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Service" - } - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServices/{serviceName}": { - "get": { - "operationId": "GetService", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service", - "schema": { - "$ref": "#/definitions/Service" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServices/{serviceName}/$/GetServiceGroupDescription": { - "get": { - "operationId": "GetServiceGroupDescription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service group description", - "schema": { - "$ref": "#/definitions/ServiceGroupDescription" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServices/{serviceName}/$/GetServiceGroupMembers": { - "get": { - "operationId": "GetServiceGroupMember", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service group description", - "schema": { - "$ref": "#/definitions/ServiceGroupMember" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetHealth": { - "get": { - "operationId": "GetApplicationHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "EventsHealthStateFilter", - "in": "query", - "description": "The filter of the events health state", - "required": false, - "type": "string" - }, - { - "name": "DeployedApplicationsHealthStateFilter", - "in": "query", - "description": "The filter of the deployed application health state", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application health", - "schema": { - "$ref": "#/definitions/ApplicationHealth" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetUpgradeProgress": { - "get": { - "operationId": "GetApplicationUpgrade", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application upgrade", - "schema": { - "$ref": "#/definitions/ApplicationUpgrade" - } - } - } - } - }, - "/Applications/{applicationName}/$/ReportHealth": { - "post": { - "operationId": "SendApplicationHealthReport", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "applicationHealthReport", - "in": "body", - "description": "The report of the application health", - "required": true, - "schema": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application health report", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/$/Create": { - "post": { - "operationId": "NewApplication", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationDescription", - "in": "body", - "description": "The description of the application", - "required": true, - "schema": { - "$ref": "#/definitions/ApplicationDescription" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application description", - "schema": { - "type": "string" - } - }, - "201": { - "description": "The application description", - "schema": { - "type": "string" - } - }, - "202": { - "description": "The application description", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServices/$/Create": { - "post": { - "operationId": "NewService", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceDescription", - "in": "body", - "description": "The description of the service", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceDescription" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service description", - "schema": { - "type": "string" - } - }, - "201": { - "description": "The service description", - "schema": { - "type": "string" - } - }, - "202": { - "description": "The service description", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServices/$/CreateFromTemplate": { - "post": { - "operationId": "NewServiceFromTemplate", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceDescriptionTemplate", - "in": "body", - "description": "The template of the service description", - "required": true, - "schema": { - "type": "object", - "properties": { - "ServiceName": { - "type": "string" - }, - "ServiceTypeName": { - "type": "string" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service description template", - "schema": { - "type": "string" - } - }, - "201": { - "description": "The service description template", - "schema": { - "type": "string" - } - }, - "202": { - "description": "The service description template", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServices/$/CreateServiceGroup": { - "post": { - "operationId": "NewServiceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the service group", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceGroupDescription", - "in": "body", - "description": "The description of the service group", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceGroupDescription" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service description", - "schema": { - "type": "string" - } - }, - "201": { - "description": "The service description", - "schema": { - "type": "string" - } - }, - "202": { - "description": "The service description", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServiceGroups/$/CreateServiceGroupFromTemplate": { - "post": { - "operationId": "NewServiceGroupFromTemplate", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceDescriptionTemplate", - "in": "body", - "description": "The template of the service description", - "required": true, - "schema": { - "type": "object", - "properties": { - "ServiceName": { - "type": "string" - }, - "ServiceTypeName": { - "type": "string" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service group description template", - "schema": { - "type": "string" - } - }, - "201": { - "description": "The service group description template", - "schema": { - "type": "string" - } - }, - "202": { - "description": "The service group description template", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServices/{serviceName}/$/UpdateServiceGroup": { - "post": { - "operationId": "UpdateServiceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceGroupUpdateDescription", - "in": "body", - "description": "The description of the service group update", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceGroupUpdateDescription" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service group update description", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/Delete": { - "post": { - "operationId": "RemoveApplication", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/Upgrade": { - "post": { - "operationId": "StartApplicationUpgrade", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "startApplicationUpgradeDescription", - "in": "body", - "description": "The description of the start application upgrade", - "required": true, - "schema": { - "$ref": "#/definitions/StartApplicationUpgradeDescription" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The start application upgrade", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/UpdateUpgrade": { - "post": { - "operationId": "UpdateApplicationUpgrade", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "updateApplicationUpgradeDescription", - "in": "body", - "description": "The description of the application upgrade", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateApplicationUpgradeDescription" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The update application upgrade", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/MoveNextUpgradeDomain": { - "post": { - "operationId": "ResumeApplicationUpgrade", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "resumeApplicationUpgrade", - "in": "body", - "description": "The upgrade of the resume application", - "required": true, - "schema": { - "type": "object", - "properties": { - "UpgradeDomainName": { - "type": "string" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The resume application upgrade", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/RollbackUpgrade": { - "post": { - "operationId": "StartApplicationUpgradeRollback", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The application upgrade rollback", - "schema": { - "type": "string" - } - } - } - } - }, - "/Services/{serviceName}/$/Update": { - "post": { - "operationId": "UpdateService", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceUpdateDescription", - "in": "body", - "description": "The description of the service update", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceUpdateDescription" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service update description", - "schema": { - "type": "string" - } - } - } - } - }, - "/Services/{serviceName}/$/Delete": { - "post": { - "operationId": "RemoveService", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service", - "schema": { - "type": "string" - } - } - } - } - }, - "/Applications/{applicationName}/$/GetServiceGroups/{serviceName}/$/Delete": { - "post": { - "operationId": "RemoveServiceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "applicationName", - "in": "path", - "description": "The name of the application", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service", - "schema": { - "type": "string" - } - } - } - } - }, - "/Services/{serviceName}/$/GetDescription": { - "get": { - "operationId": "GetServiceDescription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service description", - "schema": { - "$ref": "#/definitions/ServiceDescription" - } - } - } - } - }, - "/Services/{serviceName}/$/ResolvePartition": { - "get": { - "operationId": "ResolveService", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "PartitionKeyType", - "in": "query", - "description": "The type of the partition key", - "type": "integer", - "required": false - }, - { - "name": "PartitionKeyValue", - "in": "query", - "description": "The value of the partition key", - "type": "string", - "required": false - }, - { - "name": "PreviousRspVersion", - "in": "query", - "description": "The version of the previous rsp", - "type": "string", - "required": false - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The partition", - "schema": { - "$ref": "#/definitions/ResolvedServicePartition" - } - } - } - } - }, - "/Services/{serviceName}/$/GetHealth": { - "get": { - "operationId": "GetServiceHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service health", - "schema": { - "$ref": "#/definitions/ServiceHealth" - } - } - } - } - }, - "/Services/{serviceName}/$/ReportHealth": { - "post": { - "operationId": "SendServiceHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "serviceHealthReport", - "in": "body", - "description": "The report of the service health", - "required": true, - "schema": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The service health", - "schema": { - "type": "string" - } - } - } - } - }, - "/Services/{serviceName}/$/GetPartitions": { - "get": { - "operationId": "GetPartitionList", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The partitions", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Partition" - } - } - } - } - } - }, - "/Services/{serviceName}/$/GetPartitions/{partitionId}": { - "get": { - "operationId": "GetPartition", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The partitions", - "schema": { - "$ref": "#/definitions/Partition" - } - } - } - } - }, - "/Services/{serviceName}/$/GetPartitions/$/Recover": { - "post": { - "operationId": "RepairPartitionList", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "serviceName", - "in": "path", - "description": "The name of the service", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The repair partition", - "schema": { - "type": "string" - } - } - } - } - }, - "/Partitions/{partitionId}/$/Recover": { - "post": { - "operationId": "RepairPartition", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The repair partition", - "schema": { - "type": "string" - } - } - } - } - }, - "/Partitions/{partitionId}/$/ResetLoad": { - "post": { - "operationId": "ResetPartitionLoad", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true, - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The reset partition load", - "schema": { - "type": "string" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas": { - "get": { - "operationId": "GetReplicaList", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The replica", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Replica" - } - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}": { - "get": { - "operationId": "GetReplica", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "name": "replicaId", - "in": "path", - "description": "The id of the replica", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The replica", - "schema": { - "$ref": "#/definitions/Replica" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetHealth": { - "get": { - "operationId": "GetPartitionHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "name": "EventsHealthStateFilter", - "in": "query", - "description": "The filter of the events health state", - "required": false, - "type": "string" - }, - { - "name": "ReplicasHealthStateFilter", - "in": "query", - "description": "The filter of the replicas health state", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The partition health", - "schema": { - "$ref": "#/definitions/PartitionHealth" - } - } - } - } - }, - "/Partitions/{partitionId}/$/ReportHealth": { - "post": { - "operationId": "SendPartitionHealthReport", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "name": "partitionHealthReport", - "in": "body", - "description": "The report of the partition health", - "required": true, - "schema": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The partition health report", - "schema": { - "type": "string" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth": { - "get": { - "operationId": "GetReplicaHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "name": "replicaId", - "in": "path", - "description": "The id of the replica", - "type": "string", - "required": true - }, - { - "name": "EventsHealthStateFilter", - "in": "query", - "description": "The filter of the events health state", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The replica health", - "schema": { - "$ref": "#/definitions/ReplicaHealth" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth": { - "post": { - "operationId": "SendReplicaHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "name": "replicaId", - "in": "path", - "description": "The id of the replica", - "type": "string", - "required": true - }, - { - "name": "replicaHealthReport", - "in": "body", - "description": "The report of the replica health", - "required": true, - "schema": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - } - } - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The replica health", - "schema": { - "type": "string" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetLoadInformation": { - "get": { - "operationId": "GetPartitionLoadInformation", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The partition load information", - "schema": { - "$ref": "#/definitions/PartitionLoadInformation" - } - } - } - } - }, - "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetLoadInformation": { - "get": { - "operationId": "GetReplicaLoadInformation", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "partitionId", - "in": "path", - "description": "The id of the partition", - "type": "string", - "required": true - }, - { - "name": "replicaId", - "in": "path", - "description": "The id of the replica", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The replica load information", - "schema": { - "$ref": "#/definitions/ReplicaLoadInformation" - } - } - } - } - }, - "/$/GetLoadInformation": { - "get": { - "operationId": "GetClusterLoadInformation", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The load information", - "schema": { - "$ref": "#/definitions/ClusterLoadInformation" - } - } - } - } - }, - "/$/GetClusterHealth": { - "get": { - "operationId": "GetClusterHealth", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "EventsHealthStateFilter", - "in": "query", - "description": "The filter of the events health state", - "type": "string", - "required": false - }, - { - "name": "NodesHealthStateFilter", - "in": "query", - "description": "The filter of the nodes health state", - "type": "string", - "required": false - }, - { - "name": "ApplicationsHealthStateFilter", - "in": "query", - "description": "The filter of the applications health state", - "type": "string", - "required": false - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The cluster health", - "schema": { - "$ref": "#/definitions/ClusterHealth" - } - } - } - } - }, - "/$/GetUpgradeProgress": { - "get": { - "operationId": "GetUpgradeProgress", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "The upgrade progress", - "schema": { - "$ref": "#/definitions/ClusterUpgradeProgress" - } - } - } - } - } - }, - "definitions": { - "Node": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "IpAddressOrFQDN": { - "type": "string" - }, - "Type": { - "type": "string" - }, - "CodeVersion": { - "type": "string" - }, - "ConfigVersion": { - "type": "string" - }, - "NodeStatus": { - "type": "integer" - }, - "NodeUpTimeInSeconds": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "IsSeedNode": { - "type": "boolean" - }, - "UpgradeDomain": { - "type": "string" - }, - "FaultDomain": { - "type": "string" - }, - "Id": { - "type": "object", - "properties": { - "Id": { - "type": "string" - } - } - }, - "InstanceId": { - "type": "string" - }, - "NodeDeactivationInfo": { - "type": "object", - "properties": { - "NodeDeactivationIntent": { - "type": "integer" - }, - "NodeDeactivationStatus": { - "type": "integer" - } - } - } - } - }, - "HealthEvent": { - "type": "object", - "properties": { - "SourceId": { - "type": "string" - }, - "Property": { - "type": "string" - }, - "HealthState": { - "type": "integer" - }, - "TimeToLiveInMilliSeconds": { - "type": "string" - }, - "Description": { - "type": "string" - }, - "SequenceNumber": { - "type": "string" - }, - "RemoveWhenExpired": { - "type": "boolean" - }, - "SourceUtcTimestamp": { - "type": "string" - }, - "LastModifiedUtcTimestamp": { - "type": "string" - }, - "IsExpired": { - "type": "boolean" - }, - "LastOkTransitionAt": { - "type": "string" - }, - "LastWarningTransitionAt": { - "type": "string" - }, - "LastErrorTransitionAt": { - "type": "string" - } - } - }, - "HealthEvaluation": { - "type": "object", - "discriminator": "Kind", - "required": [ - "Kind" - ], - "properties": { - "Kind": { - "type": "integer" - }, - "Description": { - "type": "string" - }, - "AggregatedHealthState": { - "type": "integer" - } - } - }, - "UnhealthyEvaluation": { - "type": "object", - "properties": { - "HealthEvaluation": { - "$ref": "#/definitions/HealthEvaluation" - } - } - }, - "EventHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "UnhealthyEvent": { - "$ref": "#/definitions/HealthEvent" - }, - "ConsiderWarningAsError": { - "type": "boolean" - } - } - }, - "PartitionsHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyPartitionsPerService": { - "type": "integer" - } - } - }, - "ReplicasHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyPartitionsPerService": { - "type": "integer" - } - } - }, - "DeployedServicePackagesHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - } - } - }, - "DeployedApplicationsHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer" - } - } - }, - "ServicesHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "ServiceTypeName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyServices": { - "type": "integer" - } - } - }, - "NodesHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyNodes": { - "type": "integer" - } - } - }, - "ApplicationsHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyApplications": { - "type": "integer" - } - } - }, - "UpgradeDomainNodesHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "x-ms-discriminator-value": "UDNodesHealthEvaluation", - "properties": { - "UpgradeDomainName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyNodes": { - "type": "integer" - } - } - }, - "UpgradeDomainDeployedApplicationsHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "x-ms-discriminator-value": "UDDeployedApplicationsHealthEvaluation", - "properties": { - "UpgradeDomainName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer" - } - } - }, - "SystemApplicationHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - } - } - }, - "PartitionHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "PartitionId": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - } - } - }, - "ReplicaHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "PartitionId": { - "type": "string" - }, - "ReplicaOrInstanceId": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - } - } - }, - "DeployedServicePackageHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "ApplicationName": { - "type": "string" - }, - "NodeName": { - "type": "string" - }, - "ServiceManifestName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - } - } - }, - "DeployedApplicationHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "ApplicationName": { - "type": "string" - }, - "NodeName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - } - } - }, - "ServiceHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "ServiceName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - } - } - }, - "NodeHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "NodeName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - } - } - }, - "ApplicationHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "properties": { - "ServiceName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - } - } - }, - "DeltaNodesCheckHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "x-ms-discriminator-value": "HealthEvaluationKindDeltaNodesCheck", - "properties": { - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "BaselineErrorCount": { - "type": "integer" - }, - "BaselineTotalCount": { - "type": "integer" - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentDeltaUnhealthyNodes": { - "type": "integer" - } - } - }, - "UpgradeDomainDeltaNodesCheckHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "x-ms-discriminator-value": "HealthEvaluationKindUpgradeDomainDeltaNodesCheck", - "properties": { - "UpgradeDomainName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "BaselineErrorCount": { - "type": "integer" - }, - "BaselineTotalCount": { - "type": "integer" - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { - "type": "integer" - } - } - }, - "ApplicationTypeHealthEvaluation": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/HealthEvaluation" - } - ], - "x-ms-discriminator-value": "ApplicationTypeApplicationsHealthEvaluation", - "properties": { - "ApplicationTypeName": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "TotalCount": { - "type": "integer" - }, - "MaxPercentUnhealthyApplications": { - "type": "integer" - } - } - }, - "NodeHealth": { - "type": "object", - "properties": { - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - } - }, - "AggregatedHealthState": { - "type": "integer" - }, - "Name": { - "type": "string" - } - } - }, - "DeployedApplication": { - "type": "object", - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "TypeName": { - "type": "string" - }, - "Status": { - "type": "integer" - }, - "WorkDirectory": { - "type": "string" - }, - "LogDirectory": { - "type": "string" - }, - "TempDirectory": { - "type": "string" - } - } - }, - "DeployedServicePackageHealthState": { - "type": "object", - "properties": { - "ApplicationName": { - "type": "string" - }, - "ServiceManifestName": { - "type": "string" - }, - "NodeName": { - "type": "string" - }, - "AggregatedHealthState": { - "type": "integer" - } - } - }, - "DeployedApplicationHealth": { - "type": "object", - "properties": { - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - } - }, - "AggregatedHealthState": { - "type": "integer" - }, - "UnhealthyEvaluations": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "NodeName": { - "type": "string" - }, - "DeployedServicePackageHealthStates": { - "$ref": "#/definitions/DeployedServicePackageHealthState" - } - } - }, - "NodeLoadMetricInformation": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "NodeCapacity": { - "type": "string" - }, - "NodeLoad": { - "type": "string" - }, - "NodeRemainingCapacity": { - "type": "string" - }, - "IsCapacityViolation": { - "type": "boolean" - }, - "NodeBufferedCapacity": { - "type": "string" - }, - "NodeRemainingBufferedCapacity": { - "type": "string" - } - } - }, - "NodeLoadInformation": { - "type": "object", - "properties": { - "NodeName": { - "type": "string" - }, - "NodeLoadMetricInformation": { - "$ref": "#/definitions/NodeLoadMetricInformation" - } - } - }, - "CodePackageEntryPointStatistics": { - "type": "object", - "properties": { - "LastExitCode": { - "type": "integer" - }, - "LastActivationTime": { - "type": "string" - }, - "LastExitTime": { - "type": "string" - }, - "LastSuccessfulActivationTime": { - "type": "string" - }, - "LastSuccessfulExitTime": { - "type": "string" - }, - "ActivationFailureCount": { - "type": "integer" - }, - "ContinuousActivationFailureCount": { - "type": "integer" - }, - "ExitFailureCount": { - "type": "integer" - }, - "ContinuousExitFailureCount": { - "type": "integer" - }, - "ActivationCount": { - "type": "integer" - }, - "ExitCount": { - "type": "integer" - } - } - }, - "EntryPoint": { - "type": "object", - "properties": { - "EntryPointLocation": { - "type": "integer" - }, - "ProcessId": { - "type": "integer" - }, - "RunAsUserName": { - "type": "integer" - }, - "NextActivationTime": { - "type": "integer" - }, - "Status": { - "type": "integer" - }, - "CodePackageEntryPointStatistics": { - "$ref": "#/definitions/CodePackageEntryPointStatistics" - } - } - }, - "DeployedCodePackage": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - }, - "ServiceManifestName": { - "type": "string" - }, - "Status": { - "type": "string" - }, - "RunFrequencyInterval": { - "type": "string" - }, - "SetupEntryPoint": { - "$ref": "#/definitions/EntryPoint" - }, - "MainEntryPoint": { - "$ref": "#/definitions/EntryPoint" - }, - "HasSetupEntryPoint": { - "type": "boolean" - } - } - }, - "DeployedReplica": { - "type": "object", - "properties": { - "ServiceKind": { - "type": "integer" - }, - "ServiceName": { - "type": "string" - }, - "ServiceTypeName": { - "type": "string" - }, - "ServiceManifestVersion": { - "type": "string" - }, - "ServiceManifestName": { - "type": "string" - }, - "CodePackageName": { - "type": "string" - }, - "PartitionId": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "ReplicaId": { - "type": "string" - }, - "ReplicaRole": { - "type": "string" - }, - "ReplicaStatus": { - "type": "integer" - }, - "Address": { - "type": "string" - } - } - }, - "DeployedReplicaDetail": { - "type": "object", - "properties": { - "ServiceKind": { - "type": "integer" - }, - "ServiceName": { - "type": "string" - }, - "PartitionId": { - "type": "string" - }, - "CurrentServiceOperation": { - "type": "integer" - }, - "CurrentReplicatorOperation": { - "type": "integer" - }, - "CurrentServiceOperationStartTimeUtc": { - "type": "string" - }, - "InstanceId": { - "type": "string" - }, - "ReplicaId": { - "type": "string" - }, - "ReadStatus": { - "type": "integer" - }, - "WriteStatus": { - "type": "integer" - }, - "ReplicatorStatus": { - "type": "object", - "properties": { - "Kind": { - "type": "integer" - }, - "ReplicationQueueStatus": { - "type": "object", - "properties": { - "QueueUtilizationPercentage": { - "type": "string" - }, - "QueueMemorySize": { - "type": "string" - }, - "FirstSequenceNumber": { - "type": "string" - }, - "CompletedSequenceNumber": { - "type": "string" - }, - "CommittedSequenceNumber": { - "type": "string" - }, - "LastSequenceNumber": { - "type": "string" - } - } - } - } - } - } - }, - "DeployedServicePackage": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - }, - "Status": { - "type": "integer" - } - } - }, - "DeployedServicePackageHealth": { - "type": "object", - "properties": { - "ApplicationName": { - "type": "string" - }, - "ServiceManifestName": { - "type": "string" - }, - "NodeName": { - "type": "string" - }, - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - } - }, - "AggregatedHealthState": { - "type": "integer" - } - } - }, - "DeployedServiceType": { - "type": "object", - "properties": { - "ServiceTypeName": { - "type": "string" - }, - "CodePackageName": { - "type": "string" - }, - "ServiceManifestName": { - "type": "string" - }, - "Status": { - "type": "integer" - } - } - }, - "ApplicationType": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "Version": { - "type": "string" - }, - "DefaultParameterList": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - } - } - } - } - }, - "ServiceManifest": { - "type": "object", - "properties": { - "Manifest": { - "type": "string" - } - } - }, - "ServiceType": { - "type": "object", - "properties": { - "ServiceTypeDescription": { - "type": "object", - "properties": { - "IsStateful": { - "type": "boolean" - }, - "ServiceTypeName": { - "type": "string" - }, - "PlacementConstraints": { - "type": "string" - }, - "HasPersistedState": { - "type": "boolean" - } - } - }, - "ServiceManifestVersion": { - "type": "string" - }, - "ServiceManifestName": { - "type": "string" - }, - "IsServiceGroup": { - "type": "boolean" - } - } - }, - "Application": { - "type": "object", - "properties": { - "Id": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "TypeName": { - "type": "string" - }, - "TypeVersion": { - "type": "string" - }, - "Status": { - "type": "integer" - }, - "Parameters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - } - } - }, - "HealthState": { - "type": "integer" - } - } - }, - "ApplicationDescription": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "TypeName": { - "type": "string" - }, - "TypeVersion": { - "type": "string" - }, - "ParameterList": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Key": { - "type": "string" - }, - "Value": { - "type": "string" - } - } - } - } - } - }, - "ApplicationManifest": { - "type": "object", - "properties": { - "Manifest": { - "type": "string" - } - } - }, - "Service": { - "type": "object", - "properties": { - "Id": { - "type": "string" - }, - "ServiceKind": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "TypeName": { - "type": "string" - }, - "ManifestVersion": { - "type": "string" - }, - "HasPersistedState": { - "type": "boolean" - }, - "HealthState": { - "type": "integer" - }, - "ServiceStatus": { - "type": "integer" - }, - "IsServiceGroup": { - "type": "boolean" - } - } - }, - "PartitionDescription": { - "type": "object", - "properties": { - "PartitionScheme": { - "type": "integer" - }, - "Count": { - "type": "integer" - }, - "Names": { - "type": "array", - "items": { - "type": "string" - } - }, - "LowKey": { - "type": "string" - }, - "HighKey": { - "type": "string" - } - } - }, - "ServiceGroupMemberDescription": { - "type": "object", - "properties": { - "ServiceName": { - "type": "string" - }, - "ServiceTypeName": { - "type": "string" - }, - "ServiceKind": { - "type": "integer" - } - } - }, - "ServiceGroupDescription": { - "type": "object", - "discriminator": "ServiceKind", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "type": "string" - }, - "ApplicationName": { - "type": "string" - }, - "ServiceName": { - "type": "string" - }, - "ServiceTypeName": { - "type": "string" - }, - "PartitionDescription": { - "$ref": "#/definitions/PartitionDescription" - }, - "PlacementConstraints": { - "type": "string" - }, - "CorrelationScheme": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "ServiceLoadMetrics": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "ServicePlacementPolicies": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "Flags": { - "type": "integer" - }, - "ServiceGroupMemberDescription": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceGroupMemberDescription" - } - } - } - }, - "StatelessServiceGroupDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceGroupDescription" - } - ], - "x-ms-discriminator-value": "FABRIC_SERVICE_KIND_STATELESS", - "properties": { - "InstanceCount": { - "type": "integer" - } - } - }, - "StatefulServiceGroupDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceGroupDescription" - } - ], - "x-ms-discriminator-value": "FABRIC_SERVICE_KIND_STATEFUL", - "properties": { - "TargetReplicaSetSize": { - "type": "integer" - }, - "MinReplicaSetSize": { - "type": "integer" - }, - "HasPersistedState": { - "type": "boolean" - }, - "ReplicaRestartWaitDurationSeconds": { - "type": "integer" - }, - "QuorumLossWaitDurationSeconds": { - "type": "integer" - }, - "StandByReplicaKeepDurationSeconds": { - "type": "integer" - }, - "DefaultMoveCost": { - "type": "integer" - }, - "IsDefaultMoveCostSpecified": { - "type": "boolean" - } - } - }, - "StatelessCreateServiceGroupDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceGroupDescription" - } - ], - "x-ms-discriminator-value": "1", - "properties": { - "InstanceCount": { - "type": "integer" - } - } - }, - "StatefulCreateServiceGroupDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceGroupDescription" - } - ], - "x-ms-discriminator-value": "2", - "properties": { - "TargetReplicaSetSize": { - "type": "integer" - }, - "MinReplicaSetSize": { - "type": "integer" - }, - "HasPersistedState": { - "type": "boolean" - }, - "ReplicaRestartWaitDurationSeconds": { - "type": "integer" - }, - "QuorumLossWaitDurationSeconds": { - "type": "integer" - }, - "StandByReplicaKeepDurationSeconds": { - "type": "integer" - }, - "DefaultMoveCost": { - "type": "integer" - }, - "IsDefaultMoveCostSpecified": { - "type": "boolean" - } - } - }, - "ServiceGroupMember": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "ServiceGroupMemberDescription": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceGroupMemberDescription" - } - } - } - }, - "ApplicationHealth": { - "type": "object", - "properties": { - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - } - }, - "AggregatedHealthState": { - "type": "integer" - }, - "UnhealthyEvaluations": { - "type": "string" - }, - "Name": { - "type": "string" - }, - "ServiceHealthStates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ServiceName": { - "type": "string" - }, - "AggregatedHealthState": { - "type": "integer" - } - } - } - }, - "DeployedApplicationHealthStates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ApplicationName": { - "type": "string" - }, - "NodeName": { - "type": "string" - }, - "AggregatedHealthState": { - "type": "integer" - } - } - } - } - } - }, - "ApplicationUpgrade": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "TypeName": { - "type": "string" - }, - "TargetApplicationTypeVersion": { - "type": "string" - }, - "UpgradeDomains": { - "type": "string" - }, - "UpgradeState": { - "type": "integer" - }, - "NextUpgradeDomain": { - "type": "string" - }, - "RollingUpgradeMode": { - "type": "integer" - }, - "UpgradeDurationInMilliseconds": { - "type": "string" - }, - "UpgradeDomainDurationInMilliseconds": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "string" - }, - "CurrentUpgradeDomainProgress": { - "type": "object", - "properties": { - "DomainName": { - "type": "string" - }, - "NodeUpgradeProgressList": { - "type": "string" - } - } - }, - "StartTimestampUtc": { - "type": "string" - }, - "FailureTimestampUtc": { - "type": "string" - }, - "FailureReason": { - "type": "integer" - }, - "DeployedApplicationHealthStates": { - "type": "object", - "properties": { - "DomainName": { - "type": "string" - }, - "NodeUpgradeProgressList": { - "type": "string" - } - } - } - } - }, - "ServiceCorrelationDescription": { - "type": "object", - "properties": { - "ServiceName": { - "type": "string" - }, - "ServiceCorrelationScheme": { - "type": "integer" - } - } - }, - "ServiceLoadMetricDescription": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "ServiceLoadMetricWeight": { - "type": "integer" - }, - "PrimaryDefaultLoad": { - "type": "integer" - }, - "SecondaryDefaultLoad": { - "type": "integer" - } - } - }, - "ServicePlacementPolicyDescription": { - "type": "object", - "properties": { - "Type": { - "type": "integer" - } - } - }, - "ServiceDescription": { - "type": "object", - "discriminator": "ServiceKind", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "type": "string" - }, - "ApplicationName": { - "type": "string" - }, - "ServiceName": { - "type": "string" - }, - "ServiceTypeName": { - "type": "string" - }, - "PartitionDescription": { - "$ref": "#/definitions/PartitionDescription" - }, - "PlacementConstraints": { - "type": "string" - }, - "CorrelationScheme": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "ServiceLoadMetrics": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "ServicePlacementPolicies": { - "$ref": "#/definitions/ServiceCorrelationDescription" - }, - "Flags": { - "type": "integer" - } - } - }, - "StatelessServiceDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceDescription" - } - ], - "x-ms-discriminator-value": "FABRIC_SERVICE_KIND_STATELESS", - "properties": { - "InstanceCount": { - "type": "integer" - } - } - }, - "StatefulServiceDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceDescription" - } - ], - "x-ms-discriminator-value": "FABRIC_SERVICE_KIND_STATEFUL", - "properties": { - "TargetReplicaSetSize": { - "type": "integer" - }, - "MinReplicaSetSize": { - "type": "integer" - }, - "HasPersistedState": { - "type": "boolean" - }, - "ReplicaRestartWaitDurationSeconds": { - "type": "integer" - }, - "QuorumLossWaitDurationSeconds": { - "type": "integer" - }, - "StandByReplicaKeepDurationSeconds": { - "type": "integer" - }, - "DefaultMoveCost": { - "type": "integer" - }, - "IsDefaultMoveCostSpecified": { - "type": "boolean" - } - } - }, - "StatelessCreateServiceDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceDescription" - } - ], - "x-ms-discriminator-value": "1", - "properties": { - "InstanceCount": { - "type": "integer" - } - } - }, - "StatefulCreateServiceDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceDescription" - } - ], - "x-ms-discriminator-value": "2", - "properties": { - "TargetReplicaSetSize": { - "type": "integer" - }, - "MinReplicaSetSize": { - "type": "integer" - }, - "HasPersistedState": { - "type": "boolean" - }, - "ReplicaRestartWaitDurationSeconds": { - "type": "integer" - }, - "QuorumLossWaitDurationSeconds": { - "type": "integer" - }, - "StandByReplicaKeepDurationSeconds": { - "type": "integer" - }, - "DefaultMoveCost": { - "type": "integer" - }, - "IsDefaultMoveCostSpecified": { - "type": "boolean" - } - } - }, - "ServiceUpdateDescription": { - "type": "object", - "discriminator": "ServiceKind", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "type": "integer" - }, - "Flags": { - "type": "integer" - } - } - }, - "StatelessServiceUpdateDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceUpdateDescription" - } - ], - "x-ms-discriminator-value": "1", - "properties": { - "InstanceCount": { - "type": "integer" - } - } - }, - "StatefulServiceUpdateDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceUpdateDescription" - } - ], - "x-ms-discriminator-value": "2", - "properties": { - "TargetReplicaSetSize": { - "type": "integer" - }, - "MinReplicaSetSize": { - "type": "integer" - }, - "ReplicaRestartWaitDurationInMilliseconds": { - "type": "integer" - }, - "QuorumLossWaitDurationInMilliseconds": { - "type": "integer" - }, - "StandByReplicaKeepDurationInMilliseconds": { - "type": "integer" - } - } - }, - "ServiceGroupUpdateDescription": { - "type": "object", - "discriminator": "ServiceKind", - "required": [ - "ServiceKind" - ], - "properties": { - "ServiceKind": { - "type": "integer" - }, - "Flags": { - "type": "integer" - } - } - }, - "StatelessServiceGroupUpdateDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceGroupUpdateDescription" - } - ], - "x-ms-discriminator-value": "1", - "properties": { - "InstanceCount": { - "type": "integer" - } - } - }, - "StatefulServiceGroupUpdateDescription": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ServiceGroupUpdateDescription" - } - ], - "x-ms-discriminator-value": "2", - "properties": { - "TargetReplicaSetSize": { - "type": "integer" - }, - "MinReplicaSetSize": { - "type": "integer" - }, - "ReplicaRestartWaitDurationInMilliseconds": { - "type": "integer" - }, - "QuorumLossWaitDurationInMilliseconds": { - "type": "integer" - }, - "StandByReplicaKeepDurationInMilliseconds": { - "type": "integer" - } - } - }, - "ServiceHealth": { - "type": "object", - "properties": { - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - } - }, - "AggregatedHealthState": { - "type": "integer" - }, - "Name": { - "type": "string" - }, - "PartitionHealthStates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "PartitionId": { - "type": "string" - }, - "AggregatedHealthState": { - "type": "integer" - } - } - } - } - } - }, - "PartitionInformation": { - "type": "object", - "properties": { - "ServicePartitionKind": { - "type": "integer" - }, - "Id": { - "type": "string" - }, - "Name": { - "type": "array", - "items": { - "type": "string" - } - }, - "LowKey": { - "type": "string" - }, - "HighKey": { - "type": "string" - } - } - }, - "Partition": { - "type": "object", - "properties": { - "ServiceKind": { - "type": "integer" - }, - "PartitionInformation": { - "$ref": "#/definitions/PartitionInformation" - }, - "TargetReplicaSetSize": { - "type": "integer" - }, - "MinReplicaSetSize": { - "type": "integer" - }, - "HealthState": { - "type": "integer" - }, - "PartitionStatus": { - "type": "integer" - }, - "CurrentConfigurationEpoch": { - "type": "object", - "properties": { - "ConfigurationVersion": { - "type": "string" - }, - "DataLossVersion": { - "type": "string" - } - } - } - } - }, - "Replica": { - "type": "object", - "properties": { - "ServiceKind": { - "type": "integer" - }, - "InstanceId": { - "type": "string" - }, - "ReplicaId": { - "type": "string" - }, - "ReplicaRole": { - "type": "integer" - }, - "ReplicaStatus": { - "type": "integer" - }, - "HealthState": { - "type": "integer" - }, - "Address": { - "type": "string" - }, - "NodeName": { - "type": "string" - }, - "LastInBuildDurationInSeconds": { - "type": "string" - } - } - }, - "PartitionHealth": { - "type": "object", - "properties": { - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - } - }, - "AggregatedHealthState": { - "type": "integer" - }, - "PartitionId": { - "type": "string" - }, - "ReplicaHealthStates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "HealthEvents": { - "type": "integer" - }, - "PartitionId": { - "type": "string" - }, - "ReplicaId": { - "type": "string" - }, - "AggregatedHealthState": { - "type": "integer" - } - } - } - } - } - }, - "ReplicaHealth": { - "type": "object", - "properties": { - "ServiceKind": { - "type": "integer" - }, - "PartitionId": { - "type": "string" - }, - "ReplicaId": { - "type": "string" - }, - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - } - }, - "AggregatedHealthState": { - "type": "integer" - } - } - }, - "PartitionLoadInformation": { - "type": "object", - "properties": { - "PartitionId": { - "type": "string" - }, - "PrimaryLoadMetricReports": { - "type": "array", - "items": { - "type": "string" - } - }, - "SecondaryLoadMetricReports": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ReplicaLoadInformation": { - "type": "object", - "properties": { - "PartitionId": { - "type": "string" - }, - "ReplicaOrInstanceId": { - "type": "string" - }, - "ReportedLoad": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "LoadMetricInformation": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "IsBalancedBefore": { - "type": "boolean" - }, - "IsBalancedAfter": { - "type": "boolean" - }, - "DeviationBefore": { - "type": "integer" - }, - "DeviationAfter": { - "type": "integer" - }, - "BalancingThreshold": { - "type": "integer" - }, - "Action": { - "type": "string" - }, - "ActivityThreshold": { - "type": "integer" - }, - "ClusterCapacity": { - "type": "string" - }, - "ClusterLoad": { - "type": "string" - }, - "RemainingUnbufferedCapacity": { - "type": "string" - }, - "NodeBufferPercentage": { - "type": "integer" - }, - "BufferedCapacity": { - "type": "string" - }, - "RemainingBufferedCapacity": { - "type": "string" - }, - "IsClusterCapacityViolation": { - "type": "boolean" - }, - "MinNodeLoadValue": { - "type": "string" - }, - "MinNodeLoadId": { - "type": "object", - "properties": { - "Id": { - "type": "string" - } - } - }, - "MaxNodeLoadValue": { - "type": "string" - }, - "MaxNodeLoadId": { - "type": "object", - "properties": { - "Id": { - "type": "string" - } - } - } - } - }, - "ClusterLoadInformation": { - "type": "object", - "properties": { - "LastBalancingStartTimeUtc": { - "type": "string" - }, - "LastBalancingEndTimeUtc": { - "type": "string" - }, - "LoadMetricInformation": { - "type": "array", - "items": { - "$ref": "#/definitions/LoadMetricInformation" - } - } - } - }, - "ClusterHealth": { - "type": "object", - "properties": { - "HealthEvents": { - "type": "array", - "items": { - "$ref": "#/definitions/HealthEvent" - } - }, - "AggregatedHealthState": { - "type": "integer" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "NodeHealthStates": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "Id": { - "type": "object", - "properties": { - "Id": { - "type": "string" - } - } - }, - "AggregatedHealthState": { - "type": "integer" - } - } - } - }, - "ApplicationHealthState": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "AggregatedHealthState": { - "type": "integer" - } - } - } - } - } - }, - "MonitoringPolicy": { - "type": "object", - "properties": { - "FailureAction": { - "type": "integer" - }, - "HealthCheckWaitDurationInMilliseconds": { - "type": "string" - }, - "HealthCheckStableDurationInMilliseconds": { - "type": "string" - }, - "HealthCheckRetryTimeoutInMilliseconds": { - "type": "string" - }, - "UpgradeTimeoutInMilliseconds": { - "type": "string" - }, - "UpgradeDomainTimeoutInMilliseconds": { - "type": "string" - } - } - }, - "ApplicationHealthPolicy": { - "type": "object", - "properties": { - "ConsiderWarningAsError": { - "type": "boolean" - }, - "MaxPercentUnhealthyDeployedApplications": { - "type": "integer" - }, - "DefaultServiceTypeHealthPolicy": { - "type": "object", - "properties": { - "MaxPercentUnhealthyServices": { - "type": "integer" - }, - "MaxPercentUnhealthyPartitionsPerService": { - "type": "integer" - }, - "MaxPercentUnhealthyReplicasPerPartition": { - "type": "integer" - } - } - } - } - }, - "StartApplicationUpgradeDescription": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "TargetApplicationTypeVersion": { - "type": "string" - }, - "Parameters": { - "type": "array", - "items": { - "type": "string" - } - }, - "UpgradeKind": { - "type": "integer" - }, - "RollingUpgradeMode": { - "type": "integer" - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "type": "integer" - }, - "ForceRestart": { - "type": "boolean" - }, - "MonitoringPolicy": { - "$ref": "#/definitions/MonitoringPolicy" - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy" - } - } - }, - "UpdateApplicationUpgradeDescription": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "UpgradeKind": { - "type": "integer" - }, - "UpdateDescription": { - "type": "object", - "properties": { - "RollingUpgradeMode": { - "type": "integer" - }, - "ForceRestart": { - "type": "boolean" - }, - "FailureAction": { - "type": "integer" - }, - "UpgradeReplicaSetCheckTimeoutInSeconds": { - "type": "integer" - }, - "HealthCheckWaitDurationInMilliseconds": { - "type": "string" - }, - "HealthCheckStableDurationInMilliseconds": { - "type": "string" - }, - "HealthCheckRetryTimeoutInMilliseconds": { - "type": "string" - }, - "UpgradeTimeoutInMilliseconds": { - "type": "string" - }, - "UpgradeDomainTimeoutInMilliseconds": { - "type": "string" - } - } - }, - "ApplicationHealthPolicy": { - "$ref": "#/definitions/ApplicationHealthPolicy" - } - } - }, - "ResolvedServicePartition": { - "type": "object", - "properties": { - "Name": { - "type": "string" - }, - "PartitionInformation": { - "$ref": "#/definitions/PartitionInformation" - }, - "Endpoints": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Kind": { - "type": "integer" - }, - "Address": { - "type": "string" - } - } - } - }, - "Version": { - "type": "string" - } - } - }, - "ClusterUpgradeProgress": { - "type": "object", - "properties": { - "CodeVersion": { - "type": "string" - }, - "ConfigVersion": { - "type": "string" - }, - "UpgradeDomains": { - "type": "array", - "items": { - "type": "string" - } - }, - "UpgradeState": { - "type": "integer" - }, - "NextUpgradeDomain": { - "type": "string" - }, - "RollingUpgradeMode": { - "type": "integer" - }, - "UpgradeDurationInMilliseconds": { - "type": "string" - }, - "UpgradeDomainDurationInMilliseconds": { - "type": "string" - }, - "UnhealthyEvaluations": { - "type": "array", - "items": { - "$ref": "#/definitions/UnhealthyEvaluation" - } - }, - "CurrentUpgradeDomainProgress": { - "type": "object", - "properties": { - "DomainName": { - "type": "string" - }, - "NodeUpgradeProgressList": { - "type": "string" - } - } - }, - "StartTimestampUtc": { - "type": "string" - }, - "FailureTimestampUtc": { - "type": "string" - }, - "FailureReason": { - "type": "integer" - }, - "UpgradeDomainProgressAtFailure": { - "type": "object", - "properties": { - "DomainName": { - "type": "string" - }, - "NodeUpgradeProgressList": { - "type": "string" - } - } - } - } - } - }, - "parameters": { - "api-version": { - "name": "api-version", - "in": "query", - "description": "The version of the api", - "required": true, - "type": "string" - } - } -} - +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricClient", + "version": "1.0.0" + }, + "host": "localhost:10710", + "paths": { + "/$/GetClusterManifest": { + "get": { + "operationId": "GetClusterManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The cluster manifest", + "schema": { + "type": "string" + } + } + } + } + }, + "/$/ReportClusterHealth": { + "post": { + "operationId": "SendClusterHealthReport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "clusterHealthReport", + "in": "body", + "description": "The report of the cluster health", + "required": true, + "schema": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The cluster health report", + "schema": { + "type": "string" + } + } + } + } + }, + "/Nodes": { + "get": { + "operationId": "GetNodeList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "name": "continuation-token", + "in": "query", + "description": "The token of the continuation", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The node array", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Node" + } + } + } + } + } + }, + "/Nodes/{nodeName}": { + "get": { + "operationId": "GetNode", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "continuation-token", + "in": "query", + "description": "The token of the continuation", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The node", + "schema": { + "$ref": "#/definitions/Node" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Activate": { + "post": { + "operationId": "EnableNode", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The node", + "schema": { + "type": "string" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Deactivate": { + "post": { + "operationId": "DisableNode", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "disableNode", + "in": "body", + "description": "The node of the disable", + "required": true, + "schema": { + "type": "object", + "properties": { + "DeactivationIntent": { + "type": "integer" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The node", + "schema": { + "type": "string" + } + } + } + } + }, + "/Nodes/{nodeName}/$/RemoveNodeState": { + "post": { + "operationId": "RemoveNodeState", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The node state", + "schema": { + "type": "string" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetHealth": { + "get": { + "operationId": "GetNodeHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "EventsHealthStateFilter", + "in": "query", + "description": "The filter of the events health state", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The node health", + "schema": { + "$ref": "#/definitions/NodeHealth" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications": { + "get": { + "operationId": "GetDeployedApplicationList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed application list", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplication" + } + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}": { + "get": { + "operationId": "GetDeployedApplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed application", + "schema": { + "$ref": "#/definitions/DeployedApplication" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetHealth": { + "get": { + "operationId": "GetDeployedApplicationHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "EventsHealthStateFilter", + "in": "query", + "description": "The filter of the events health state", + "required": false, + "type": "string" + }, + { + "name": "DeployedServicePackagesHealthStateFilter", + "in": "query", + "description": "The filter of the deployed service packages health state", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed application health", + "schema": { + "$ref": "#/definitions/DeployedApplicationHealth" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetLoadInformation": { + "get": { + "operationId": "GetNodeLoadInformation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The node load information", + "schema": { + "$ref": "#/definitions/NodeLoadInformation" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetCodePackages": { + "get": { + "operationId": "GetDeployedCodePackage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed code package", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedCodePackage" + } + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetReplicas": { + "get": { + "operationId": "GetDeployedReplica", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed replica", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedReplica" + } + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionName}/$/GetReplicas/{replicaId}/$/GetDetail": { + "get": { + "operationId": "GetDeployedReplicaDetail", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "partitionName", + "in": "path", + "description": "The name of the partition", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "replicaId", + "in": "path", + "description": "The id of the replica", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed replica detail", + "schema": { + "$ref": "#/definitions/DeployedReplicaDetail" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetServicePackages": { + "get": { + "operationId": "GetDeployedServicePackage", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed service package", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackage" + } + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetServicePackages/{servicePackageName}/$/GetHealth": { + "get": { + "operationId": "GetDeployedServicePackageHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "servicePackageName", + "in": "path", + "description": "The name of the service package", + "type": "string", + "required": true + }, + { + "name": "EventsHealthStateFilter", + "in": "query", + "description": "The filter of the events health state", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed service package health", + "schema": { + "$ref": "#/definitions/DeployedServicePackageHealth" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetServiceTypes": { + "get": { + "operationId": "GetDeployedServiceType", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed service type", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServiceType" + } + } + } + } + } + }, + "/Nodes/{nodeName}/$/ReportHealth": { + "post": { + "operationId": "SendNodeHealthReport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "nodeHealthReport", + "in": "body", + "description": "The report of the node health", + "required": true, + "schema": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The node health report", + "schema": { + "type": "string" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/ReportHealth": { + "post": { + "operationId": "SendDeployedApplicationHealthReport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "deployedApplicationHealthReport", + "in": "body", + "description": "The report of the deployed application health", + "required": true, + "schema": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed application health report", + "schema": { + "type": "string" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationName}/$/GetServicePackages/{serviceManifestName}/$/ReportHealth": { + "post": { + "operationId": "SendDeployedServicePackageHealthReport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "nodeName", + "in": "path", + "description": "The name of the node", + "type": "string", + "required": true + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceManifestName", + "in": "path", + "description": "The name of the service manifest", + "type": "string", + "required": true + }, + { + "name": "deployedServicePackageHealthReport", + "in": "body", + "description": "The report of the deployed service package health", + "required": true, + "schema": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The deployed service package health report", + "schema": { + "type": "string" + } + } + } + } + }, + "/ApplicationTypes": { + "get": { + "operationId": "GetApplicationTypeList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application type", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationType" + } + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}": { + "get": { + "operationId": "GetApplicationType", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application type", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationType" + } + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest": { + "get": { + "operationId": "GetServiceManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type", + "type": "string", + "required": true + }, + { + "name": "ApplicationTypeVersion", + "in": "query", + "description": "The version of the application type", + "required": true, + "type": "string" + }, + { + "name": "ServiceManifestName", + "in": "query", + "description": "The name of the service manifest", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service manifest", + "schema": { + "$ref": "#/definitions/ServiceManifest" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes": { + "get": { + "operationId": "GetServiceType", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type", + "type": "string", + "required": true + }, + { + "name": "ApplicationTypeVersion", + "in": "query", + "description": "The version of the application type", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service type", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceType" + } + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest": { + "get": { + "operationId": "GetApplicationManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type", + "type": "string", + "required": true + }, + { + "name": "ApplicationTypeVersion", + "in": "query", + "description": "The version of the application type", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "continuation-token", + "in": "query", + "description": "The token of the continuation", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The application manifest", + "schema": { + "$ref": "#/definitions/ApplicationManifest" + } + } + } + } + }, + "/ApplicationTypes/$/Provision": { + "post": { + "operationId": "RegisterApplicationType", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "RegisterApplicationType", + "in": "body", + "description": "The type of the register application", + "required": true, + "schema": { + "type": "object", + "properties": { + "ApplicationTypeBuildPath": { + "type": "string" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application type", + "schema": { + "type": "string" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/Unprovision": { + "post": { + "operationId": "UnregisterApplicationType", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type", + "type": "string", + "required": true + }, + { + "name": "UnregisterApplicationType", + "in": "body", + "description": "The type of the unregister application", + "required": true, + "schema": { + "type": "object", + "properties": { + "ApplicationTypeVersion": { + "type": "string" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application type", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications": { + "get": { + "operationId": "GetApplicationList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "name": "continuation-token", + "in": "query", + "description": "The token of the continuation", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The application", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Application" + } + } + } + } + } + }, + "/Applications/{applicationName}": { + "get": { + "operationId": "GetApplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "continuation-token", + "in": "query", + "description": "The token of the continuation", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The application", + "schema": { + "$ref": "#/definitions/Application" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServices": { + "get": { + "operationId": "GetServiceList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Service" + } + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServices/{serviceName}": { + "get": { + "operationId": "GetService", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service", + "schema": { + "$ref": "#/definitions/Service" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServices/{serviceName}/$/GetServiceGroupDescription": { + "get": { + "operationId": "GetServiceGroupDescription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service group description", + "schema": { + "$ref": "#/definitions/ServiceGroupDescription" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServices/{serviceName}/$/GetServiceGroupMembers": { + "get": { + "operationId": "GetServiceGroupMember", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service group description", + "schema": { + "$ref": "#/definitions/ServiceGroupMember" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetHealth": { + "get": { + "operationId": "GetApplicationHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "EventsHealthStateFilter", + "in": "query", + "description": "The filter of the events health state", + "required": false, + "type": "string" + }, + { + "name": "DeployedApplicationsHealthStateFilter", + "in": "query", + "description": "The filter of the deployed application health state", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application health", + "schema": { + "$ref": "#/definitions/ApplicationHealth" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetUpgradeProgress": { + "get": { + "operationId": "GetApplicationUpgrade", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application upgrade", + "schema": { + "$ref": "#/definitions/ApplicationUpgrade" + } + } + } + } + }, + "/Applications/{applicationName}/$/ReportHealth": { + "post": { + "operationId": "SendApplicationHealthReport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "applicationHealthReport", + "in": "body", + "description": "The report of the application health", + "required": true, + "schema": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application health report", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/$/Create": { + "post": { + "operationId": "NewApplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationDescription", + "in": "body", + "description": "The description of the application", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application description", + "schema": { + "type": "string" + } + }, + "201": { + "description": "The application description", + "schema": { + "type": "string" + } + }, + "202": { + "description": "The application description", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServices/$/Create": { + "post": { + "operationId": "NewService", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceDescription", + "in": "body", + "description": "The description of the service", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service description", + "schema": { + "type": "string" + } + }, + "201": { + "description": "The service description", + "schema": { + "type": "string" + } + }, + "202": { + "description": "The service description", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServices/$/CreateFromTemplate": { + "post": { + "operationId": "NewServiceFromTemplate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceDescriptionTemplate", + "in": "body", + "description": "The template of the service description", + "required": true, + "schema": { + "type": "object", + "properties": { + "ServiceName": { + "type": "string" + }, + "ServiceTypeName": { + "type": "string" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service description template", + "schema": { + "type": "string" + } + }, + "201": { + "description": "The service description template", + "schema": { + "type": "string" + } + }, + "202": { + "description": "The service description template", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServices/$/CreateServiceGroup": { + "post": { + "operationId": "NewServiceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the service group", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceGroupDescription", + "in": "body", + "description": "The description of the service group", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceGroupDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service description", + "schema": { + "type": "string" + } + }, + "201": { + "description": "The service description", + "schema": { + "type": "string" + } + }, + "202": { + "description": "The service description", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServiceGroups/$/CreateServiceGroupFromTemplate": { + "post": { + "operationId": "NewServiceGroupFromTemplate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceDescriptionTemplate", + "in": "body", + "description": "The template of the service description", + "required": true, + "schema": { + "type": "object", + "properties": { + "ServiceName": { + "type": "string" + }, + "ServiceTypeName": { + "type": "string" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service group description template", + "schema": { + "type": "string" + } + }, + "201": { + "description": "The service group description template", + "schema": { + "type": "string" + } + }, + "202": { + "description": "The service group description template", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServices/{serviceName}/$/UpdateServiceGroup": { + "post": { + "operationId": "UpdateServiceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceGroupUpdateDescription", + "in": "body", + "description": "The description of the service group update", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceGroupUpdateDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service group update description", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/Delete": { + "post": { + "operationId": "RemoveApplication", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/Upgrade": { + "post": { + "operationId": "StartApplicationUpgrade", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "startApplicationUpgradeDescription", + "in": "body", + "description": "The description of the start application upgrade", + "required": true, + "schema": { + "$ref": "#/definitions/StartApplicationUpgradeDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The start application upgrade", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/UpdateUpgrade": { + "post": { + "operationId": "UpdateApplicationUpgrade", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "updateApplicationUpgradeDescription", + "in": "body", + "description": "The description of the application upgrade", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateApplicationUpgradeDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The update application upgrade", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/MoveNextUpgradeDomain": { + "post": { + "operationId": "ResumeApplicationUpgrade", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "resumeApplicationUpgrade", + "in": "body", + "description": "The upgrade of the resume application", + "required": true, + "schema": { + "type": "object", + "properties": { + "UpgradeDomainName": { + "type": "string" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The resume application upgrade", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/RollbackUpgrade": { + "post": { + "operationId": "StartApplicationUpgradeRollback", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The application upgrade rollback", + "schema": { + "type": "string" + } + } + } + } + }, + "/Services/{serviceName}/$/Update": { + "post": { + "operationId": "UpdateService", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceUpdateDescription", + "in": "body", + "description": "The description of the service update", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceUpdateDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service update description", + "schema": { + "type": "string" + } + } + } + } + }, + "/Services/{serviceName}/$/Delete": { + "post": { + "operationId": "RemoveService", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service", + "schema": { + "type": "string" + } + } + } + } + }, + "/Applications/{applicationName}/$/GetServiceGroups/{serviceName}/$/Delete": { + "post": { + "operationId": "RemoveServiceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationName", + "in": "path", + "description": "The name of the application", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service", + "schema": { + "type": "string" + } + } + } + } + }, + "/Services/{serviceName}/$/GetDescription": { + "get": { + "operationId": "GetServiceDescription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service description", + "schema": { + "$ref": "#/definitions/ServiceDescription" + } + } + } + } + }, + "/Services/{serviceName}/$/ResolvePartition": { + "get": { + "operationId": "ResolveService", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "PartitionKeyType", + "in": "query", + "description": "The type of the partition key", + "type": "integer", + "required": false + }, + { + "name": "PartitionKeyValue", + "in": "query", + "description": "The value of the partition key", + "type": "string", + "required": false + }, + { + "name": "PreviousRspVersion", + "in": "query", + "description": "The version of the previous rsp", + "type": "string", + "required": false + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The partition", + "schema": { + "$ref": "#/definitions/ResolvedServicePartition" + } + } + } + } + }, + "/Services/{serviceName}/$/GetHealth": { + "get": { + "operationId": "GetServiceHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service health", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + } + } + } + }, + "/Services/{serviceName}/$/ReportHealth": { + "post": { + "operationId": "SendServiceHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "serviceHealthReport", + "in": "body", + "description": "The report of the service health", + "required": true, + "schema": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The service health", + "schema": { + "type": "string" + } + } + } + } + }, + "/Services/{serviceName}/$/GetPartitions": { + "get": { + "operationId": "GetPartitionList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The partitions", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Partition" + } + } + } + } + } + }, + "/Services/{serviceName}/$/GetPartitions/{partitionId}": { + "get": { + "operationId": "GetPartition", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The partitions", + "schema": { + "$ref": "#/definitions/Partition" + } + } + } + } + }, + "/Services/{serviceName}/$/GetPartitions/$/Recover": { + "post": { + "operationId": "RepairPartitionList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "serviceName", + "in": "path", + "description": "The name of the service", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The repair partition", + "schema": { + "type": "string" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Recover": { + "post": { + "operationId": "RepairPartition", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The repair partition", + "schema": { + "type": "string" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ResetLoad": { + "post": { + "operationId": "ResetPartitionLoad", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The reset partition load", + "schema": { + "type": "string" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas": { + "get": { + "operationId": "GetReplicaList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The replica", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}": { + "get": { + "operationId": "GetReplica", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "name": "replicaId", + "in": "path", + "description": "The id of the replica", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The replica", + "schema": { + "$ref": "#/definitions/Replica" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetHealth": { + "get": { + "operationId": "GetPartitionHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "name": "EventsHealthStateFilter", + "in": "query", + "description": "The filter of the events health state", + "required": false, + "type": "string" + }, + { + "name": "ReplicasHealthStateFilter", + "in": "query", + "description": "The filter of the replicas health state", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The partition health", + "schema": { + "$ref": "#/definitions/PartitionHealth" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ReportHealth": { + "post": { + "operationId": "SendPartitionHealthReport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "name": "partitionHealthReport", + "in": "body", + "description": "The report of the partition health", + "required": true, + "schema": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The partition health report", + "schema": { + "type": "string" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth": { + "get": { + "operationId": "GetReplicaHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "name": "replicaId", + "in": "path", + "description": "The id of the replica", + "type": "string", + "required": true + }, + { + "name": "EventsHealthStateFilter", + "in": "query", + "description": "The filter of the events health state", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The replica health", + "schema": { + "$ref": "#/definitions/ReplicaHealth" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth": { + "post": { + "operationId": "SendReplicaHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "name": "replicaId", + "in": "path", + "description": "The id of the replica", + "type": "string", + "required": true + }, + { + "name": "replicaHealthReport", + "in": "body", + "description": "The report of the replica health", + "required": true, + "schema": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + } + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The replica health", + "schema": { + "type": "string" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetLoadInformation": { + "get": { + "operationId": "GetPartitionLoadInformation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The partition load information", + "schema": { + "$ref": "#/definitions/PartitionLoadInformation" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetLoadInformation": { + "get": { + "operationId": "GetReplicaLoadInformation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "partitionId", + "in": "path", + "description": "The id of the partition", + "type": "string", + "required": true + }, + { + "name": "replicaId", + "in": "path", + "description": "The id of the replica", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The replica load information", + "schema": { + "$ref": "#/definitions/ReplicaLoadInformation" + } + } + } + } + }, + "/$/GetLoadInformation": { + "get": { + "operationId": "GetClusterLoadInformation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The load information", + "schema": { + "$ref": "#/definitions/ClusterLoadInformation" + } + } + } + } + }, + "/$/GetClusterHealth": { + "get": { + "operationId": "GetClusterHealth", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "EventsHealthStateFilter", + "in": "query", + "description": "The filter of the events health state", + "type": "string", + "required": false + }, + { + "name": "NodesHealthStateFilter", + "in": "query", + "description": "The filter of the nodes health state", + "type": "string", + "required": false + }, + { + "name": "ApplicationsHealthStateFilter", + "in": "query", + "description": "The filter of the applications health state", + "type": "string", + "required": false + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The cluster health", + "schema": { + "$ref": "#/definitions/ClusterHealth" + } + } + } + } + }, + "/$/GetUpgradeProgress": { + "get": { + "operationId": "GetUpgradeProgress", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The upgrade progress", + "schema": { + "$ref": "#/definitions/ClusterUpgradeProgress" + } + } + } + } + } + }, + "definitions": { + "Node": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "IpAddressOrFQDN": { + "type": "string" + }, + "Type": { + "type": "string" + }, + "CodeVersion": { + "type": "string" + }, + "ConfigVersion": { + "type": "string" + }, + "NodeStatus": { + "type": "integer" + }, + "NodeUpTimeInSeconds": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "IsSeedNode": { + "type": "boolean" + }, + "UpgradeDomain": { + "type": "string" + }, + "FaultDomain": { + "type": "string" + }, + "Id": { + "type": "object", + "properties": { + "Id": { + "type": "string" + } + } + }, + "InstanceId": { + "type": "string" + }, + "NodeDeactivationInfo": { + "type": "object", + "properties": { + "NodeDeactivationIntent": { + "type": "integer" + }, + "NodeDeactivationStatus": { + "type": "integer" + } + } + } + } + }, + "HealthEvent": { + "type": "object", + "properties": { + "SourceId": { + "type": "string" + }, + "Property": { + "type": "string" + }, + "HealthState": { + "type": "integer" + }, + "TimeToLiveInMilliSeconds": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "SequenceNumber": { + "type": "string" + }, + "RemoveWhenExpired": { + "type": "boolean" + }, + "SourceUtcTimestamp": { + "type": "string" + }, + "LastModifiedUtcTimestamp": { + "type": "string" + }, + "IsExpired": { + "type": "boolean" + }, + "LastOkTransitionAt": { + "type": "string" + }, + "LastWarningTransitionAt": { + "type": "string" + }, + "LastErrorTransitionAt": { + "type": "string" + } + } + }, + "HealthEvaluation": { + "type": "object", + "discriminator": "Kind", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "type": "integer" + }, + "Description": { + "type": "string" + }, + "AggregatedHealthState": { + "type": "integer" + } + } + }, + "UnhealthyEvaluation": { + "type": "object", + "properties": { + "HealthEvaluation": { + "$ref": "#/definitions/HealthEvaluation" + } + } + }, + "EventHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvent": { + "$ref": "#/definitions/HealthEvent" + }, + "ConsiderWarningAsError": { + "type": "boolean" + } + } + }, + "PartitionsHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer" + } + } + }, + "ReplicasHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer" + } + } + }, + "DeployedServicePackagesHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + } + } + }, + "DeployedApplicationsHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer" + } + } + }, + "ServicesHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ServiceTypeName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyServices": { + "type": "integer" + } + } + }, + "NodesHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyNodes": { + "type": "integer" + } + } + }, + "ApplicationsHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyApplications": { + "type": "integer" + } + } + }, + "UpgradeDomainNodesHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "x-ms-discriminator-value": "UDNodesHealthEvaluation", + "properties": { + "UpgradeDomainName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyNodes": { + "type": "integer" + } + } + }, + "UpgradeDomainDeployedApplicationsHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "x-ms-discriminator-value": "UDDeployedApplicationsHealthEvaluation", + "properties": { + "UpgradeDomainName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer" + } + } + }, + "SystemApplicationHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + } + } + }, + "PartitionHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "PartitionId": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + } + } + }, + "ReplicaHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "PartitionId": { + "type": "string" + }, + "ReplicaOrInstanceId": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + } + } + }, + "DeployedServicePackageHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ApplicationName": { + "type": "string" + }, + "NodeName": { + "type": "string" + }, + "ServiceManifestName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + } + } + }, + "DeployedApplicationHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ApplicationName": { + "type": "string" + }, + "NodeName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + } + } + }, + "ServiceHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ServiceName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + } + } + }, + "NodeHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "NodeName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + } + } + }, + "ApplicationHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ServiceName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + } + } + }, + "DeltaNodesCheckHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "x-ms-discriminator-value": "HealthEvaluationKindDeltaNodesCheck", + "properties": { + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "BaselineErrorCount": { + "type": "integer" + }, + "BaselineTotalCount": { + "type": "integer" + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer" + } + } + }, + "UpgradeDomainDeltaNodesCheckHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "x-ms-discriminator-value": "HealthEvaluationKindUpgradeDomainDeltaNodesCheck", + "properties": { + "UpgradeDomainName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "BaselineErrorCount": { + "type": "integer" + }, + "BaselineTotalCount": { + "type": "integer" + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer" + } + } + }, + "ApplicationTypeHealthEvaluation": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "x-ms-discriminator-value": "ApplicationTypeApplicationsHealthEvaluation", + "properties": { + "ApplicationTypeName": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "TotalCount": { + "type": "integer" + }, + "MaxPercentUnhealthyApplications": { + "type": "integer" + } + } + }, + "NodeHealth": { + "type": "object", + "properties": { + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + } + }, + "AggregatedHealthState": { + "type": "integer" + }, + "Name": { + "type": "string" + } + } + }, + "DeployedApplication": { + "type": "object", + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "TypeName": { + "type": "string" + }, + "Status": { + "type": "integer" + }, + "WorkDirectory": { + "type": "string" + }, + "LogDirectory": { + "type": "string" + }, + "TempDirectory": { + "type": "string" + } + } + }, + "DeployedServicePackageHealthState": { + "type": "object", + "properties": { + "ApplicationName": { + "type": "string" + }, + "ServiceManifestName": { + "type": "string" + }, + "NodeName": { + "type": "string" + }, + "AggregatedHealthState": { + "type": "integer" + } + } + }, + "DeployedApplicationHealth": { + "type": "object", + "properties": { + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + } + }, + "AggregatedHealthState": { + "type": "integer" + }, + "UnhealthyEvaluations": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "NodeName": { + "type": "string" + }, + "DeployedServicePackageHealthStates": { + "$ref": "#/definitions/DeployedServicePackageHealthState" + } + } + }, + "NodeLoadMetricInformation": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "NodeCapacity": { + "type": "string" + }, + "NodeLoad": { + "type": "string" + }, + "NodeRemainingCapacity": { + "type": "string" + }, + "IsCapacityViolation": { + "type": "boolean" + }, + "NodeBufferedCapacity": { + "type": "string" + }, + "NodeRemainingBufferedCapacity": { + "type": "string" + } + } + }, + "NodeLoadInformation": { + "type": "object", + "properties": { + "NodeName": { + "type": "string" + }, + "NodeLoadMetricInformation": { + "$ref": "#/definitions/NodeLoadMetricInformation" + } + } + }, + "CodePackageEntryPointStatistics": { + "type": "object", + "properties": { + "LastExitCode": { + "type": "integer" + }, + "LastActivationTime": { + "type": "string" + }, + "LastExitTime": { + "type": "string" + }, + "LastSuccessfulActivationTime": { + "type": "string" + }, + "LastSuccessfulExitTime": { + "type": "string" + }, + "ActivationFailureCount": { + "type": "integer" + }, + "ContinuousActivationFailureCount": { + "type": "integer" + }, + "ExitFailureCount": { + "type": "integer" + }, + "ContinuousExitFailureCount": { + "type": "integer" + }, + "ActivationCount": { + "type": "integer" + }, + "ExitCount": { + "type": "integer" + } + } + }, + "EntryPoint": { + "type": "object", + "properties": { + "EntryPointLocation": { + "type": "integer" + }, + "ProcessId": { + "type": "integer" + }, + "RunAsUserName": { + "type": "integer" + }, + "NextActivationTime": { + "type": "integer" + }, + "Status": { + "type": "integer" + }, + "CodePackageEntryPointStatistics": { + "$ref": "#/definitions/CodePackageEntryPointStatistics" + } + } + }, + "DeployedCodePackage": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "Version": { + "type": "string" + }, + "ServiceManifestName": { + "type": "string" + }, + "Status": { + "type": "string" + }, + "RunFrequencyInterval": { + "type": "string" + }, + "SetupEntryPoint": { + "$ref": "#/definitions/EntryPoint" + }, + "MainEntryPoint": { + "$ref": "#/definitions/EntryPoint" + }, + "HasSetupEntryPoint": { + "type": "boolean" + } + } + }, + "DeployedReplica": { + "type": "object", + "properties": { + "ServiceKind": { + "type": "integer" + }, + "ServiceName": { + "type": "string" + }, + "ServiceTypeName": { + "type": "string" + }, + "ServiceManifestVersion": { + "type": "string" + }, + "ServiceManifestName": { + "type": "string" + }, + "CodePackageName": { + "type": "string" + }, + "PartitionId": { + "type": "string" + }, + "InstanceId": { + "type": "string" + }, + "ReplicaId": { + "type": "string" + }, + "ReplicaRole": { + "type": "string" + }, + "ReplicaStatus": { + "type": "integer" + }, + "Address": { + "type": "string" + } + } + }, + "DeployedReplicaDetail": { + "type": "object", + "properties": { + "ServiceKind": { + "type": "integer" + }, + "ServiceName": { + "type": "string" + }, + "PartitionId": { + "type": "string" + }, + "CurrentServiceOperation": { + "type": "integer" + }, + "CurrentReplicatorOperation": { + "type": "integer" + }, + "CurrentServiceOperationStartTimeUtc": { + "type": "string" + }, + "InstanceId": { + "type": "string" + }, + "ReplicaId": { + "type": "string" + }, + "ReadStatus": { + "type": "integer" + }, + "WriteStatus": { + "type": "integer" + }, + "ReplicatorStatus": { + "type": "object", + "properties": { + "Kind": { + "type": "integer" + }, + "ReplicationQueueStatus": { + "type": "object", + "properties": { + "QueueUtilizationPercentage": { + "type": "string" + }, + "QueueMemorySize": { + "type": "string" + }, + "FirstSequenceNumber": { + "type": "string" + }, + "CompletedSequenceNumber": { + "type": "string" + }, + "CommittedSequenceNumber": { + "type": "string" + }, + "LastSequenceNumber": { + "type": "string" + } + } + } + } + } + } + }, + "DeployedServicePackage": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "Version": { + "type": "string" + }, + "Status": { + "type": "integer" + } + } + }, + "DeployedServicePackageHealth": { + "type": "object", + "properties": { + "ApplicationName": { + "type": "string" + }, + "ServiceManifestName": { + "type": "string" + }, + "NodeName": { + "type": "string" + }, + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + } + }, + "AggregatedHealthState": { + "type": "integer" + } + } + }, + "DeployedServiceType": { + "type": "object", + "properties": { + "ServiceTypeName": { + "type": "string" + }, + "CodePackageName": { + "type": "string" + }, + "ServiceManifestName": { + "type": "string" + }, + "Status": { + "type": "integer" + } + } + }, + "ApplicationType": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "Version": { + "type": "string" + }, + "DefaultParameterList": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + } + } + } + }, + "ServiceManifest": { + "type": "object", + "properties": { + "Manifest": { + "type": "string" + } + } + }, + "ServiceType": { + "type": "object", + "properties": { + "ServiceTypeDescription": { + "type": "object", + "properties": { + "IsStateful": { + "type": "boolean" + }, + "ServiceTypeName": { + "type": "string" + }, + "PlacementConstraints": { + "type": "string" + }, + "HasPersistedState": { + "type": "boolean" + } + } + }, + "ServiceManifestVersion": { + "type": "string" + }, + "ServiceManifestName": { + "type": "string" + }, + "IsServiceGroup": { + "type": "boolean" + } + } + }, + "Application": { + "type": "object", + "properties": { + "Id": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "TypeName": { + "type": "string" + }, + "TypeVersion": { + "type": "string" + }, + "Status": { + "type": "integer" + }, + "Parameters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + } + }, + "HealthState": { + "type": "integer" + } + } + }, + "ApplicationDescription": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "TypeName": { + "type": "string" + }, + "TypeVersion": { + "type": "string" + }, + "ParameterList": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + } + } + } + }, + "ApplicationManifest": { + "type": "object", + "properties": { + "Manifest": { + "type": "string" + } + } + }, + "Service": { + "type": "object", + "properties": { + "Id": { + "type": "string" + }, + "ServiceKind": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "TypeName": { + "type": "string" + }, + "ManifestVersion": { + "type": "string" + }, + "HasPersistedState": { + "type": "boolean" + }, + "HealthState": { + "type": "integer" + }, + "ServiceStatus": { + "type": "integer" + }, + "IsServiceGroup": { + "type": "boolean" + } + } + }, + "PartitionDescription": { + "type": "object", + "properties": { + "PartitionScheme": { + "type": "integer" + }, + "Count": { + "type": "integer" + }, + "Names": { + "type": "array", + "items": { + "type": "string" + } + }, + "LowKey": { + "type": "string" + }, + "HighKey": { + "type": "string" + } + } + }, + "ServiceGroupMemberDescription": { + "type": "object", + "properties": { + "ServiceName": { + "type": "string" + }, + "ServiceTypeName": { + "type": "string" + }, + "ServiceKind": { + "type": "integer" + } + } + }, + "ServiceGroupDescription": { + "type": "object", + "discriminator": "ServiceKind", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "type": "string" + }, + "ApplicationName": { + "type": "string" + }, + "ServiceName": { + "type": "string" + }, + "ServiceTypeName": { + "type": "string" + }, + "PartitionDescription": { + "$ref": "#/definitions/PartitionDescription" + }, + "PlacementConstraints": { + "type": "string" + }, + "CorrelationScheme": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "ServiceLoadMetrics": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "Flags": { + "type": "integer" + }, + "ServiceGroupMemberDescription": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceGroupMemberDescription" + } + } + } + }, + "StatelessServiceGroupDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceGroupDescription" + } + ], + "x-ms-discriminator-value": "FABRIC_SERVICE_KIND_STATELESS", + "properties": { + "InstanceCount": { + "type": "integer" + } + } + }, + "StatefulServiceGroupDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceGroupDescription" + } + ], + "x-ms-discriminator-value": "FABRIC_SERVICE_KIND_STATEFUL", + "properties": { + "TargetReplicaSetSize": { + "type": "integer" + }, + "MinReplicaSetSize": { + "type": "integer" + }, + "HasPersistedState": { + "type": "boolean" + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "integer" + }, + "QuorumLossWaitDurationSeconds": { + "type": "integer" + }, + "StandByReplicaKeepDurationSeconds": { + "type": "integer" + }, + "DefaultMoveCost": { + "type": "integer" + }, + "IsDefaultMoveCostSpecified": { + "type": "boolean" + } + } + }, + "StatelessCreateServiceGroupDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceGroupDescription" + } + ], + "x-ms-discriminator-value": "1", + "properties": { + "InstanceCount": { + "type": "integer" + } + } + }, + "StatefulCreateServiceGroupDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceGroupDescription" + } + ], + "x-ms-discriminator-value": "2", + "properties": { + "TargetReplicaSetSize": { + "type": "integer" + }, + "MinReplicaSetSize": { + "type": "integer" + }, + "HasPersistedState": { + "type": "boolean" + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "integer" + }, + "QuorumLossWaitDurationSeconds": { + "type": "integer" + }, + "StandByReplicaKeepDurationSeconds": { + "type": "integer" + }, + "DefaultMoveCost": { + "type": "integer" + }, + "IsDefaultMoveCostSpecified": { + "type": "boolean" + } + } + }, + "ServiceGroupMember": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "ServiceGroupMemberDescription": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceGroupMemberDescription" + } + } + } + }, + "ApplicationHealth": { + "type": "object", + "properties": { + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + } + }, + "AggregatedHealthState": { + "type": "integer" + }, + "UnhealthyEvaluations": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "ServiceHealthStates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ServiceName": { + "type": "string" + }, + "AggregatedHealthState": { + "type": "integer" + } + } + } + }, + "DeployedApplicationHealthStates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ApplicationName": { + "type": "string" + }, + "NodeName": { + "type": "string" + }, + "AggregatedHealthState": { + "type": "integer" + } + } + } + } + } + }, + "ApplicationUpgrade": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "TypeName": { + "type": "string" + }, + "TargetApplicationTypeVersion": { + "type": "string" + }, + "UpgradeDomains": { + "type": "string" + }, + "UpgradeState": { + "type": "integer" + }, + "NextUpgradeDomain": { + "type": "string" + }, + "RollingUpgradeMode": { + "type": "integer" + }, + "UpgradeDurationInMilliseconds": { + "type": "string" + }, + "UpgradeDomainDurationInMilliseconds": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "string" + }, + "CurrentUpgradeDomainProgress": { + "type": "object", + "properties": { + "DomainName": { + "type": "string" + }, + "NodeUpgradeProgressList": { + "type": "string" + } + } + }, + "StartTimestampUtc": { + "type": "string" + }, + "FailureTimestampUtc": { + "type": "string" + }, + "FailureReason": { + "type": "integer" + }, + "DeployedApplicationHealthStates": { + "type": "object", + "properties": { + "DomainName": { + "type": "string" + }, + "NodeUpgradeProgressList": { + "type": "string" + } + } + } + } + }, + "ServiceCorrelationDescription": { + "type": "object", + "properties": { + "ServiceName": { + "type": "string" + }, + "ServiceCorrelationScheme": { + "type": "integer" + } + } + }, + "ServiceLoadMetricDescription": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "ServiceLoadMetricWeight": { + "type": "integer" + }, + "PrimaryDefaultLoad": { + "type": "integer" + }, + "SecondaryDefaultLoad": { + "type": "integer" + } + } + }, + "ServicePlacementPolicyDescription": { + "type": "object", + "properties": { + "Type": { + "type": "integer" + } + } + }, + "ServiceDescription": { + "type": "object", + "discriminator": "ServiceKind", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "type": "string" + }, + "ApplicationName": { + "type": "string" + }, + "ServiceName": { + "type": "string" + }, + "ServiceTypeName": { + "type": "string" + }, + "PartitionDescription": { + "$ref": "#/definitions/PartitionDescription" + }, + "PlacementConstraints": { + "type": "string" + }, + "CorrelationScheme": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "ServiceLoadMetrics": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "Flags": { + "type": "integer" + } + } + }, + "StatelessServiceDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + } + ], + "x-ms-discriminator-value": "FABRIC_SERVICE_KIND_STATELESS", + "properties": { + "InstanceCount": { + "type": "integer" + } + } + }, + "StatefulServiceDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + } + ], + "x-ms-discriminator-value": "FABRIC_SERVICE_KIND_STATEFUL", + "properties": { + "TargetReplicaSetSize": { + "type": "integer" + }, + "MinReplicaSetSize": { + "type": "integer" + }, + "HasPersistedState": { + "type": "boolean" + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "integer" + }, + "QuorumLossWaitDurationSeconds": { + "type": "integer" + }, + "StandByReplicaKeepDurationSeconds": { + "type": "integer" + }, + "DefaultMoveCost": { + "type": "integer" + }, + "IsDefaultMoveCostSpecified": { + "type": "boolean" + } + } + }, + "StatelessCreateServiceDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + } + ], + "x-ms-discriminator-value": "1", + "properties": { + "InstanceCount": { + "type": "integer" + } + } + }, + "StatefulCreateServiceDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + } + ], + "x-ms-discriminator-value": "2", + "properties": { + "TargetReplicaSetSize": { + "type": "integer" + }, + "MinReplicaSetSize": { + "type": "integer" + }, + "HasPersistedState": { + "type": "boolean" + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "integer" + }, + "QuorumLossWaitDurationSeconds": { + "type": "integer" + }, + "StandByReplicaKeepDurationSeconds": { + "type": "integer" + }, + "DefaultMoveCost": { + "type": "integer" + }, + "IsDefaultMoveCostSpecified": { + "type": "boolean" + } + } + }, + "ServiceUpdateDescription": { + "type": "object", + "discriminator": "ServiceKind", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "type": "integer" + }, + "Flags": { + "type": "integer" + } + } + }, + "StatelessServiceUpdateDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "1", + "properties": { + "InstanceCount": { + "type": "integer" + } + } + }, + "StatefulServiceUpdateDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "2", + "properties": { + "TargetReplicaSetSize": { + "type": "integer" + }, + "MinReplicaSetSize": { + "type": "integer" + }, + "ReplicaRestartWaitDurationInMilliseconds": { + "type": "integer" + }, + "QuorumLossWaitDurationInMilliseconds": { + "type": "integer" + }, + "StandByReplicaKeepDurationInMilliseconds": { + "type": "integer" + } + } + }, + "ServiceGroupUpdateDescription": { + "type": "object", + "discriminator": "ServiceKind", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "type": "integer" + }, + "Flags": { + "type": "integer" + } + } + }, + "StatelessServiceGroupUpdateDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceGroupUpdateDescription" + } + ], + "x-ms-discriminator-value": "1", + "properties": { + "InstanceCount": { + "type": "integer" + } + } + }, + "StatefulServiceGroupUpdateDescription": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceGroupUpdateDescription" + } + ], + "x-ms-discriminator-value": "2", + "properties": { + "TargetReplicaSetSize": { + "type": "integer" + }, + "MinReplicaSetSize": { + "type": "integer" + }, + "ReplicaRestartWaitDurationInMilliseconds": { + "type": "integer" + }, + "QuorumLossWaitDurationInMilliseconds": { + "type": "integer" + }, + "StandByReplicaKeepDurationInMilliseconds": { + "type": "integer" + } + } + }, + "ServiceHealth": { + "type": "object", + "properties": { + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + } + }, + "AggregatedHealthState": { + "type": "integer" + }, + "Name": { + "type": "string" + }, + "PartitionHealthStates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "PartitionId": { + "type": "string" + }, + "AggregatedHealthState": { + "type": "integer" + } + } + } + } + } + }, + "PartitionInformation": { + "type": "object", + "properties": { + "ServicePartitionKind": { + "type": "integer" + }, + "Id": { + "type": "string" + }, + "Name": { + "type": "array", + "items": { + "type": "string" + } + }, + "LowKey": { + "type": "string" + }, + "HighKey": { + "type": "string" + } + } + }, + "Partition": { + "type": "object", + "properties": { + "ServiceKind": { + "type": "integer" + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation" + }, + "TargetReplicaSetSize": { + "type": "integer" + }, + "MinReplicaSetSize": { + "type": "integer" + }, + "HealthState": { + "type": "integer" + }, + "PartitionStatus": { + "type": "integer" + }, + "CurrentConfigurationEpoch": { + "type": "object", + "properties": { + "ConfigurationVersion": { + "type": "string" + }, + "DataLossVersion": { + "type": "string" + } + } + } + } + }, + "Replica": { + "type": "object", + "properties": { + "ServiceKind": { + "type": "integer" + }, + "InstanceId": { + "type": "string" + }, + "ReplicaId": { + "type": "string" + }, + "ReplicaRole": { + "type": "integer" + }, + "ReplicaStatus": { + "type": "integer" + }, + "HealthState": { + "type": "integer" + }, + "Address": { + "type": "string" + }, + "NodeName": { + "type": "string" + }, + "LastInBuildDurationInSeconds": { + "type": "string" + } + } + }, + "PartitionHealth": { + "type": "object", + "properties": { + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + } + }, + "AggregatedHealthState": { + "type": "integer" + }, + "PartitionId": { + "type": "string" + }, + "ReplicaHealthStates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "HealthEvents": { + "type": "integer" + }, + "PartitionId": { + "type": "string" + }, + "ReplicaId": { + "type": "string" + }, + "AggregatedHealthState": { + "type": "integer" + } + } + } + } + } + }, + "ReplicaHealth": { + "type": "object", + "properties": { + "ServiceKind": { + "type": "integer" + }, + "PartitionId": { + "type": "string" + }, + "ReplicaId": { + "type": "string" + }, + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + } + }, + "AggregatedHealthState": { + "type": "integer" + } + } + }, + "PartitionLoadInformation": { + "type": "object", + "properties": { + "PartitionId": { + "type": "string" + }, + "PrimaryLoadMetricReports": { + "type": "array", + "items": { + "type": "string" + } + }, + "SecondaryLoadMetricReports": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReplicaLoadInformation": { + "type": "object", + "properties": { + "PartitionId": { + "type": "string" + }, + "ReplicaOrInstanceId": { + "type": "string" + }, + "ReportedLoad": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "LoadMetricInformation": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "IsBalancedBefore": { + "type": "boolean" + }, + "IsBalancedAfter": { + "type": "boolean" + }, + "DeviationBefore": { + "type": "integer" + }, + "DeviationAfter": { + "type": "integer" + }, + "BalancingThreshold": { + "type": "integer" + }, + "Action": { + "type": "string" + }, + "ActivityThreshold": { + "type": "integer" + }, + "ClusterCapacity": { + "type": "string" + }, + "ClusterLoad": { + "type": "string" + }, + "RemainingUnbufferedCapacity": { + "type": "string" + }, + "NodeBufferPercentage": { + "type": "integer" + }, + "BufferedCapacity": { + "type": "string" + }, + "RemainingBufferedCapacity": { + "type": "string" + }, + "IsClusterCapacityViolation": { + "type": "boolean" + }, + "MinNodeLoadValue": { + "type": "string" + }, + "MinNodeLoadId": { + "type": "object", + "properties": { + "Id": { + "type": "string" + } + } + }, + "MaxNodeLoadValue": { + "type": "string" + }, + "MaxNodeLoadId": { + "type": "object", + "properties": { + "Id": { + "type": "string" + } + } + } + } + }, + "ClusterLoadInformation": { + "type": "object", + "properties": { + "LastBalancingStartTimeUtc": { + "type": "string" + }, + "LastBalancingEndTimeUtc": { + "type": "string" + }, + "LoadMetricInformation": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadMetricInformation" + } + } + } + }, + "ClusterHealth": { + "type": "object", + "properties": { + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + } + }, + "AggregatedHealthState": { + "type": "integer" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "NodeHealthStates": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "Id": { + "type": "object", + "properties": { + "Id": { + "type": "string" + } + } + }, + "AggregatedHealthState": { + "type": "integer" + } + } + } + }, + "ApplicationHealthState": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "AggregatedHealthState": { + "type": "integer" + } + } + } + } + } + }, + "MonitoringPolicy": { + "type": "object", + "properties": { + "FailureAction": { + "type": "integer" + }, + "HealthCheckWaitDurationInMilliseconds": { + "type": "string" + }, + "HealthCheckStableDurationInMilliseconds": { + "type": "string" + }, + "HealthCheckRetryTimeoutInMilliseconds": { + "type": "string" + }, + "UpgradeTimeoutInMilliseconds": { + "type": "string" + }, + "UpgradeDomainTimeoutInMilliseconds": { + "type": "string" + } + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean" + }, + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer" + }, + "DefaultServiceTypeHealthPolicy": { + "type": "object", + "properties": { + "MaxPercentUnhealthyServices": { + "type": "integer" + }, + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer" + }, + "MaxPercentUnhealthyReplicasPerPartition": { + "type": "integer" + } + } + } + } + }, + "StartApplicationUpgradeDescription": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "TargetApplicationTypeVersion": { + "type": "string" + }, + "Parameters": { + "type": "array", + "items": { + "type": "string" + } + }, + "UpgradeKind": { + "type": "integer" + }, + "RollingUpgradeMode": { + "type": "integer" + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "type": "integer" + }, + "ForceRestart": { + "type": "boolean" + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicy" + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy" + } + } + }, + "UpdateApplicationUpgradeDescription": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "UpgradeKind": { + "type": "integer" + }, + "UpdateDescription": { + "type": "object", + "properties": { + "RollingUpgradeMode": { + "type": "integer" + }, + "ForceRestart": { + "type": "boolean" + }, + "FailureAction": { + "type": "integer" + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "type": "integer" + }, + "HealthCheckWaitDurationInMilliseconds": { + "type": "string" + }, + "HealthCheckStableDurationInMilliseconds": { + "type": "string" + }, + "HealthCheckRetryTimeoutInMilliseconds": { + "type": "string" + }, + "UpgradeTimeoutInMilliseconds": { + "type": "string" + }, + "UpgradeDomainTimeoutInMilliseconds": { + "type": "string" + } + } + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy" + } + } + }, + "ResolvedServicePartition": { + "type": "object", + "properties": { + "Name": { + "type": "string" + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation" + }, + "Endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Kind": { + "type": "integer" + }, + "Address": { + "type": "string" + } + } + } + }, + "Version": { + "type": "string" + } + } + }, + "ClusterUpgradeProgress": { + "type": "object", + "properties": { + "CodeVersion": { + "type": "string" + }, + "ConfigVersion": { + "type": "string" + }, + "UpgradeDomains": { + "type": "array", + "items": { + "type": "string" + } + }, + "UpgradeState": { + "type": "integer" + }, + "NextUpgradeDomain": { + "type": "string" + }, + "RollingUpgradeMode": { + "type": "integer" + }, + "UpgradeDurationInMilliseconds": { + "type": "string" + }, + "UpgradeDomainDurationInMilliseconds": { + "type": "string" + }, + "UnhealthyEvaluations": { + "type": "array", + "items": { + "$ref": "#/definitions/UnhealthyEvaluation" + } + }, + "CurrentUpgradeDomainProgress": { + "type": "object", + "properties": { + "DomainName": { + "type": "string" + }, + "NodeUpgradeProgressList": { + "type": "string" + } + } + }, + "StartTimestampUtc": { + "type": "string" + }, + "FailureTimestampUtc": { + "type": "string" + }, + "FailureReason": { + "type": "integer" + }, + "UpgradeDomainProgressAtFailure": { + "type": "object", + "properties": { + "DomainName": { + "type": "string" + }, + "NodeUpgradeProgressList": { + "type": "string" + } + } + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the api", + "required": true, + "type": "string" + } + } +} + diff --git a/arm-sql/2015-05-01/swagger/sql.json b/arm-sql/2015-05-01/swagger/sql.json index f4001b33c182..b324f1971d3e 100644 --- a/arm-sql/2015-05-01/swagger/sql.json +++ b/arm-sql/2015-05-01/swagger/sql.json @@ -1,256 +1,256 @@ -{ - "swagger": "2.0", - "info": { - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete Databases, Servers and related resources.", - "version": "2015-05-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies/Default": { - "put": { - "x-ms-long-running-operation": true, - "tags": [ - "SecurityAlertPolicy" - ], - "operationId": "SecurityAlertPolicy_CreateOrUpdate", - "description": "Creates or updates an Azure SQL Server security alert policy.", - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicyCreateOrUpdateParameters" - }, - "description": "The required parameters for creating or updating a Azure SQL Server security alert policy." - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Resource Group to which the server belongs." - }, - { - "name": "serverName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure SQL Server." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Server Threat Detection Policy", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - "201": { - "description": "The Server Threat Detection Policy", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - } - } - }, - "get": { - "tags": [ - "SecurityAlertPolicy" - ], - "operationId": "SecurityAlertPolicy_Get", - "description": "Returns an Azure SQL Server security alert policy.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Resource Group to which the server belongs." - }, - { - "name": "serverName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure SQL Server." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The Server Threat Detection Policy", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - } - } - } - } - }, - "definitions": { - "ServerSecurityAlertPolicyProperties": { - "properties": { - "state": { - "readOnly": true, - "type": "string", - "description": "The state of the Azure SQL Security alert policy (New, Enabled or Disabled).", - "enum": [ - "Enabled", - "Disabled", - "New" - ], - "x-ms-enum": { - "name": "State", - "modelAsString": false - } - }, - "disabledAlerts": { - "readOnly": true, - "type": "string", - "description": "The disable alerts of the Azure SQL Security alert policy." - }, - "emailAddresses": { - "readOnly": true, - "type": "string", - "description": "The list of email addresses to send the alert." - }, - "emailAccountAdmins": { - "readOnly": true, - "type": "string", - "description": "Value that indicated whether to email the azure account admins.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "EmailAccountAdmins", - "modelAsString": false - } - } - }, - "description": "Represents the properties of an Azure SQL Security alert policy." - }, - "ServerSecurityAlertPolicyCreateOrUpdateParameters": { - "x-ms-azure-resource": true, - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", - "description": "Properties of the request." - } - }, - "required": [ - "properties" - ], - "description": "Create or update server security alert policy parameters." - }, - "ServerSecurityAlertPolicy": { - "x-ms-azure-resource": true, - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", - "description": "Represents the properties of the resource." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Represents an Azure SQL Server Security Alert Policy." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription credentials which uniquely identify Microsoft Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } - } +{ + "swagger": "2.0", + "info": { + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete Databases, Servers and related resources.", + "version": "2015-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies/Default": { + "put": { + "x-ms-long-running-operation": true, + "tags": [ + "SecurityAlertPolicy" + ], + "operationId": "SecurityAlertPolicy_CreateOrUpdate", + "description": "Creates or updates an Azure SQL Server security alert policy.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicyCreateOrUpdateParameters" + }, + "description": "The required parameters for creating or updating a Azure SQL Server security alert policy." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the server belongs." + }, + { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure SQL Server." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Server Threat Detection Policy", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "201": { + "description": "The Server Threat Detection Policy", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + } + } + }, + "get": { + "tags": [ + "SecurityAlertPolicy" + ], + "operationId": "SecurityAlertPolicy_Get", + "description": "Returns an Azure SQL Server security alert policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Resource Group to which the server belongs." + }, + { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure SQL Server." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The Server Threat Detection Policy", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + } + } + } + } + }, + "definitions": { + "ServerSecurityAlertPolicyProperties": { + "properties": { + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the Azure SQL Security alert policy (New, Enabled or Disabled).", + "enum": [ + "Enabled", + "Disabled", + "New" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": false + } + }, + "disabledAlerts": { + "readOnly": true, + "type": "string", + "description": "The disable alerts of the Azure SQL Security alert policy." + }, + "emailAddresses": { + "readOnly": true, + "type": "string", + "description": "The list of email addresses to send the alert." + }, + "emailAccountAdmins": { + "readOnly": true, + "type": "string", + "description": "Value that indicated whether to email the azure account admins.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EmailAccountAdmins", + "modelAsString": false + } + } + }, + "description": "Represents the properties of an Azure SQL Security alert policy." + }, + "ServerSecurityAlertPolicyCreateOrUpdateParameters": { + "x-ms-azure-resource": true, + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", + "description": "Properties of the request." + } + }, + "required": [ + "properties" + ], + "description": "Create or update server security alert policy parameters." + }, + "ServerSecurityAlertPolicy": { + "x-ms-azure-resource": true, + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerSecurityAlertPolicyProperties", + "description": "Represents the properties of the resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Represents an Azure SQL Server Security Alert Policy." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } } \ No newline at end of file diff --git a/arm-storage/2015-05-01-preview/swagger/storage.json b/arm-storage/2015-05-01-preview/swagger/storage.json index 65c97a8a7876..478e2eebab89 100644 --- a/arm-storage/2015-05-01-preview/swagger/storage.json +++ b/arm-storage/2015-05-01-preview/swagger/storage.json @@ -1,821 +1,821 @@ -{ - "swagger": "2.0", - "info": { - "title": "StorageManagementClient", - "description": "The Storage Management Client.", - "version": "2015-05-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_CheckNameAvailability", - "description": "Checks that account name is valid and is not in use.", - "parameters": [ - { - "name": "accountName", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" - }, - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { - "put": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Create", - "description": "Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountCreateParameters" - }, - "description": "The parameters to provide for the created account." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - }, - "202": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Delete", - "description": "Deletes a storage account in Microsoft Azure.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - }, - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_GetProperties", - "description": "Returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - } - } - }, - "patch": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Update", - "description": "Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. This API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountUpdateParameters" - }, - "description": "The parameters to update on the account. Note that only one property can be changed at a time using this API. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_ListKeys", - "description": "Lists the access keys for the specified storage account.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_List", - "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_ListByResourceGroup", - "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_RegenerateKey", - "description": "Regenerates the access keys for the specified storage account.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " - }, - { - "name": "regenerateKey", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" - }, - "description": "Specifies name of the key which should be regenerated." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { - "get": { - "tags": [ - "Usage" - ], - "operationId": "Usage_List", - "description": "Gets the current usage count and the limit for the resources under the subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/UsageListResult" - } - } - } - } - } - }, - "definitions": { - "StorageAccountCheckNameAvailabilityParameters": { - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - } - }, - "CheckNameAvailabilityResult": { - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." - }, - "reason": { - "type": "string", - "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", - "enum": [ - "AccountNameInvalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "Reason", - "modelAsString": false - } - }, - "message": { - "type": "string", - "description": "Gets an error message explaining the Reason value in more detail." - } - }, - "description": "The CheckNameAvailability operation response." - }, - "StorageAccountPropertiesCreateParameters": { - "properties": { - "accountType": { - "type": "string", - "description": "Gets or sets the account type.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - } - } - }, - "StorageAccountCreateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The parameters to provide for the account." - }, - "Endpoints": { - "properties": { - "blob": { - "type": "string", - "description": "Gets the blob endpoint." - }, - "queue": { - "type": "string", - "description": "Gets the queue endpoint." - }, - "table": { - "type": "string", - "description": "Gets the table endpoint." - } - }, - "description": "The URIs that are used to perform a retrieval of a public blob, queue or table object." - }, - "CustomDomain": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name. Name is the CNAME source." - }, - "useSubDomain": { - "type": "boolean", - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" - } - }, - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "StorageAccountProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets the status of the storage account at the time the operation was called.", - "enum": [ - "Creating", - "ResolvingDNS", - "Succeeded" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "accountType": { - "type": "string", - "description": "Gets the type of the storage account.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - }, - "primaryEndpoints": { - "$ref": "#/definitions/Endpoints", - "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint." - }, - "primaryLocation": { - "type": "string", - "description": "Gets the location of the primary for the storage account." - }, - "statusOfPrimary": { - "type": "string", - "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": false - } - }, - "lastGeoFailoverTime": { - "type": "string", - "format": "date-time", - "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS." - }, - "secondaryLocation": { - "type": "string", - "description": "Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS." - }, - "statusOfSecondary": { - "type": "string", - "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": false - } - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets the creation date and time of the storage account in UTC." - }, - "customDomain": { - "$ref": "#/definitions/CustomDomain", - "description": "Gets the user assigned custom domain assigned to this storage account." - }, - "secondaryEndpoints": { - "$ref": "#/definitions/Endpoints", - "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS." - } - } - }, - "StorageAccount": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The storage account." - }, - "StorageAccountKeys": { - "properties": { - "key1": { - "type": "string", - "description": "Gets the value of key 1." - }, - "key2": { - "type": "string", - "description": "Gets the value of key 2." - } - }, - "description": "The access keys for the storage account." - }, - "StorageAccountListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/StorageAccount" - }, - "description": "Gets the list of storage accounts and their properties." - }, - "nextLink": { - "type": "string", - "description": "Gets the link to the next set of results. Currently this will always be empty as the API does not support pagination." - } - }, - "description": "The list storage accounts operation response." - }, - "StorageAccountPropertiesUpdateParameters": { - "properties": { - "accountType": { - "type": "string", - "description": "Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - }, - "customDomain": { - "$ref": "#/definitions/CustomDomain", - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - } - } - }, - "StorageAccountUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The parameters to update on the account." - }, - "StorageAccountRegenerateKeyParameters": { - "properties": { - "keyName": { - "type": "string", - "enum": [ - "key1", - "key2" - ], - "x-ms-enum": { - "name": "KeyName", - "modelAsString": false - } - } - } - }, - "UsageName": { - "properties": { - "value": { - "type": "string", - "description": "Gets a string describing the resource name." - }, - "localizedValue": { - "type": "string", - "description": "Gets a localized string describing the resource name." - } - }, - "description": "The Usage Names." - }, - "Usage": { - "properties": { - "unit": { - "type": "string", - "description": "Gets the unit of measurement.", - "enum": [ - "Count", - "Bytes", - "Seconds", - "Percent", - "CountsPerSecond", - "BytesPerSecond" - ], - "x-ms-enum": { - "name": "UsageUnit", - "modelAsString": false - } - }, - "currentValue": { - "type": "integer", - "format": "int32", - "description": "Gets the current count of the allocated resources in the subscription." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "Gets the maximum count of the resources that can be allocated in the subscription." - }, - "name": { - "$ref": "#/definitions/UsageName", - "description": "Gets the name of the type of usage." - } - }, - "description": "Describes Storage Resource Usage." - }, - "UsageListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "description": "Gets or sets the list Storage Resource Usages." - } - }, - "description": "The List Usages operation response." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": 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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "StorageManagementClient", + "description": "The Storage Management Client.", + "version": "2015-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_CheckNameAvailability", + "description": "Checks that account name is valid and is not in use.", + "parameters": [ + { + "name": "accountName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" + }, + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { + "put": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Create", + "description": "Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Delete", + "description": "Deletes a storage account in Microsoft Azure.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_GetProperties", + "description": "Returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "patch": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Update", + "description": "Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. This API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to update on the account. Note that only one property can be changed at a time using this API. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListKeys", + "description": "Lists the access keys for the specified storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListByResourceGroup", + "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RegenerateKey", + "description": "Regenerates the access keys for the specified storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. " + }, + { + "name": "regenerateKey", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" + }, + "description": "Specifies name of the key which should be regenerated." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets the current usage count and the limit for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + } + } + } + }, + "definitions": { + "StorageAccountCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." + }, + "reason": { + "type": "string", + "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "StorageAccountPropertiesCreateParameters": { + "properties": { + "accountType": { + "type": "string", + "description": "Gets or sets the account type.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + } + } + }, + "StorageAccountCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The parameters to provide for the account." + }, + "Endpoints": { + "properties": { + "blob": { + "type": "string", + "description": "Gets the blob endpoint." + }, + "queue": { + "type": "string", + "description": "Gets the queue endpoint." + }, + "table": { + "type": "string", + "description": "Gets the table endpoint." + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, queue or table object." + }, + "CustomDomain": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the custom domain name. Name is the CNAME source." + }, + "useSubDomain": { + "type": "boolean", + "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" + } + }, + "description": "The custom domain assigned to this storage account. This can be set via Update." + }, + "StorageAccountProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets the status of the storage account at the time the operation was called.", + "enum": [ + "Creating", + "ResolvingDNS", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "accountType": { + "type": "string", + "description": "Gets the type of the storage account.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + }, + "primaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint." + }, + "primaryLocation": { + "type": "string", + "description": "Gets the location of the primary for the storage account." + }, + "statusOfPrimary": { + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "lastGeoFailoverTime": { + "type": "string", + "format": "date-time", + "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS." + }, + "secondaryLocation": { + "type": "string", + "description": "Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS." + }, + "statusOfSecondary": { + "type": "string", + "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets the creation date and time of the storage account in UTC." + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "Gets the user assigned custom domain assigned to this storage account." + }, + "secondaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS." + } + } + }, + "StorageAccount": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The storage account." + }, + "StorageAccountKeys": { + "properties": { + "key1": { + "type": "string", + "description": "Gets the value of key 1." + }, + "key2": { + "type": "string", + "description": "Gets the value of key 2." + } + }, + "description": "The access keys for the storage account." + }, + "StorageAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets the list of storage accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "Gets the link to the next set of results. Currently this will always be empty as the API does not support pagination." + } + }, + "description": "The list storage accounts operation response." + }, + "StorageAccountPropertiesUpdateParameters": { + "properties": { + "accountType": { + "type": "string", + "description": "Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + } + } + }, + "StorageAccountUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The parameters to update on the account." + }, + "StorageAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "enum": [ + "key1", + "key2" + ], + "x-ms-enum": { + "name": "KeyName", + "modelAsString": false + } + } + } + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "Gets a string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "Gets a localized string describing the resource name." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "Gets the unit of measurement.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountsPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "Gets the current count of the allocated resources in the subscription." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "Gets the maximum count of the resources that can be allocated in the subscription." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "Gets the name of the type of usage." + } + }, + "description": "Describes Storage Resource Usage." + }, + "UsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "Gets or sets the list Storage Resource Usages." + } + }, + "description": "The List Usages operation response." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": 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." + } + } } \ No newline at end of file diff --git a/arm-storage/2015-06-15/swagger/storage.json b/arm-storage/2015-06-15/swagger/storage.json index fc7c3c052e7f..661ea49d67ab 100644 --- a/arm-storage/2015-06-15/swagger/storage.json +++ b/arm-storage/2015-06-15/swagger/storage.json @@ -1,848 +1,848 @@ -{ - "swagger": "2.0", - "info": { - "title": "StorageManagementClient", - "description": "The Storage Management Client.", - "version": "2015-06-15" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_CheckNameAvailability", - "description": "Checks that account name is valid and is not in use.", - "parameters": [ - { - "name": "accountName", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" - }, - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { - "put": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Create", - "description": "Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned. ", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountCreateParameters" - }, - "description": "The parameters to provide for the created account." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - }, - "202": { - "description": "" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Delete", - "description": "Deletes a storage account in Microsoft Azure.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "" - }, - "204": { - "description": "" - } - } - }, - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_GetProperties", - "description": "Returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - } - } - }, - "patch": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_Update", - "description": "Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. In order to replace a custom domain, the old value must be cleared before a new value may be set. To clear a custom domain, simply update the custom domain with empty string. Then call update again with the new cutsom domain name. The update API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountUpdateParameters" - }, - "description": "The parameters to update on the account. Note that only one property can be changed at a time using this API. " - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccount" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_ListKeys", - "description": "Lists the access keys for the specified storage account.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account.", - "maxLength": 24, - "minLength": 3 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_List", - "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { - "get": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_ListByResourceGroup", - "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { - "post": { - "tags": [ - "StorageAccounts" - ], - "operationId": "StorageAccounts_RegenerateKey", - "description": "Regenerates the access keys for the specified storage account.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription." - }, - { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", - "maxLength": 24, - "minLength": 3 - }, - { - "name": "regenerateKey", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" - }, - "description": "Specifies name of the key which should be regenerated. key1 or key2 for the default keys" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/StorageAccountKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { - "get": { - "tags": [ - "Usage" - ], - "operationId": "Usage_List", - "description": "Gets the current usage count and the limit for the resources under the subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "$ref": "#/definitions/UsageListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - } - }, - "definitions": { - "StorageAccountCheckNameAvailabilityParameters": { - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string", - "default": "Microsoft.Storage/storageAccounts" - } - }, - "required": [ - "name" - ] - }, - "CheckNameAvailabilityResult": { - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." - }, - "reason": { - "type": "string", - "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", - "enum": [ - "AccountNameInvalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "Reason", - "modelAsString": false - } - }, - "message": { - "type": "string", - "description": "Gets an error message explaining the Reason value in more detail." - } - }, - "description": "The CheckNameAvailability operation response." - }, - "StorageAccountPropertiesCreateParameters": { - "properties": { - "accountType": { - "type": "string", - "description": "Gets or sets the account type.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - } - }, - "required": [ - "accountType" - ] - }, - "StorageAccountCreateParameters": { - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true, - "description": "The parameters to provide for the account." - }, - "Endpoints": { - "properties": { - "blob": { - "type": "string", - "description": "Gets the blob endpoint." - }, - "queue": { - "type": "string", - "description": "Gets the queue endpoint." - }, - "table": { - "type": "string", - "description": "Gets the table endpoint." - }, - "file": { - "type": "string", - "description": "Gets the file endpoint." - } - }, - "description": "The URIs that are used to perform a retrieval of a public blob, queue or table object." - }, - "CustomDomain": { - "properties": { - "name": { - "type": "string", - "description": "Gets or sets the custom domain name. Name is the CNAME source." - }, - "useSubDomain": { - "type": "boolean", - "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" - } - }, - "required": [ - "name" - ], - "description": "The custom domain assigned to this storage account. This can be set via Update." - }, - "StorageAccountProperties": { - "properties": { - "provisioningState": { - "type": "string", - "description": "Gets the status of the storage account at the time the operation was called.", - "enum": [ - "Creating", - "ResolvingDNS", - "Succeeded" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "accountType": { - "type": "string", - "description": "Gets the type of the storage account.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - }, - "primaryEndpoints": { - "$ref": "#/definitions/Endpoints", - "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint." - }, - "primaryLocation": { - "type": "string", - "description": "Gets the location of the primary for the storage account." - }, - "statusOfPrimary": { - "type": "string", - "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": false - } - }, - "lastGeoFailoverTime": { - "type": "string", - "format": "date-time", - "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS." - }, - "secondaryLocation": { - "type": "string", - "description": "Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS." - }, - "statusOfSecondary": { - "type": "string", - "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.", - "enum": [ - "Available", - "Unavailable" - ], - "x-ms-enum": { - "name": "AccountStatus", - "modelAsString": false - } - }, - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Gets the creation date and time of the storage account in UTC." - }, - "customDomain": { - "$ref": "#/definitions/CustomDomain", - "description": "Gets the user assigned custom domain assigned to this storage account." - }, - "secondaryEndpoints": { - "$ref": "#/definitions/Endpoints", - "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS." - } - } - }, - "StorageAccount": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The storage account." - }, - "StorageAccountKeys": { - "properties": { - "key1": { - "type": "string", - "description": "Gets the value of key 1." - }, - "key2": { - "type": "string", - "description": "Gets the value of key 2." - } - }, - "description": "The access keys for the storage account." - }, - "StorageAccountListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/StorageAccount" - }, - "description": "Gets the list of storage accounts and their properties." - } - }, - "description": "The list storage accounts operation response." - }, - "StorageAccountPropertiesUpdateParameters": { - "properties": { - "accountType": { - "type": "string", - "description": "Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.", - "enum": [ - "Standard_LRS", - "Standard_ZRS", - "Standard_GRS", - "Standard_RAGRS", - "Premium_LRS" - ], - "x-ms-enum": { - "name": "AccountType", - "modelAsString": false - } - }, - "customDomain": { - "$ref": "#/definitions/CustomDomain", - "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." - } - } - }, - "StorageAccountUpdateParameters": { - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters" - } - }, - "x-ms-azure-resource": true, - "description": "The parameters to update on the account." - }, - "StorageAccountRegenerateKeyParameters": { - "properties": { - "keyName": { - "type": "string" - } - }, - "required": [ - "keyName" - ] - }, - "UsageName": { - "properties": { - "value": { - "type": "string", - "description": "Gets a string describing the resource name." - }, - "localizedValue": { - "type": "string", - "description": "Gets a localized string describing the resource name." - } - }, - "description": "The Usage Names." - }, - "Usage": { - "properties": { - "unit": { - "type": "string", - "description": "Gets the unit of measurement.", - "enum": [ - "Count", - "Bytes", - "Seconds", - "Percent", - "CountsPerSecond", - "BytesPerSecond" - ], - "x-ms-enum": { - "name": "UsageUnit", - "modelAsString": false - } - }, - "currentValue": { - "type": "integer", - "format": "int32", - "description": "Gets the current count of the allocated resources in the subscription." - }, - "limit": { - "type": "integer", - "format": "int32", - "description": "Gets the maximum count of the resources that can be allocated in the subscription." - }, - "name": { - "$ref": "#/definitions/UsageName", - "description": "Gets the name of the type of usage." - } - }, - "required": [ - "unit", - "currentValue", - "limit", - "name" - ], - "description": "Describes Storage Resource Usage." - }, - "UsageListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "description": "Gets or sets the list Storage Resource Usages." - } - }, - "description": "The List Usages operation response." - }, - "Resource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "x-ms-azure-resource": true - } - }, - "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." - } - } +{ + "swagger": "2.0", + "info": { + "title": "StorageManagementClient", + "description": "The Storage Management Client.", + "version": "2015-06-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_CheckNameAvailability", + "description": "Checks that account name is valid and is not in use.", + "parameters": [ + { + "name": "accountName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" + }, + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}": { + "put": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Create", + "description": "Asynchronously creates a new storage account with the specified parameters. Existing accounts cannot be updated with this API and should instead use the Update Storage Account API. If an account is already created and subsequent PUT request is issued with exact same set of properties, then HTTP 200 would be returned. ", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCreateParameters" + }, + "description": "The parameters to provide for the created account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Delete", + "description": "Deletes a storage account in Microsoft Azure.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_GetProperties", + "description": "Returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "patch": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Update", + "description": "Updates the account type or tags for a storage account. It can also be used to add a custom domain (note that custom domains cannot be added via the Create operation). Only one custom domain is supported per storage account. In order to replace a custom domain, the old value must be cleared before a new value may be set. To clear a custom domain, simply update the custom domain with empty string. Then call update again with the new cutsom domain name. The update API can only be used to update one of tags, accountType, or customDomain per call. To update multiple of these properties, call the API multiple times with one change per call. This call does not change the storage keys for the account. If you want to change storage account keys, use the RegenerateKey operation. The location and name of the storage account cannot be changed after creation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountUpdateParameters" + }, + "description": "The parameters to update on the account. Note that only one property can be changed at a time using this API. " + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListKeys", + "description": "Lists the access keys for the specified storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account.", + "maxLength": 24, + "minLength": 3 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_List", + "description": "Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_ListByResourceGroup", + "description": "Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_RegenerateKey", + "description": "Regenerates the access keys for the specified storage account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "maxLength": 24, + "minLength": 3 + }, + { + "name": "regenerateKey", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountRegenerateKeyParameters" + }, + "description": "Specifies name of the key which should be regenerated. key1 or key2 for the default keys" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccountKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets the current usage count and the limit for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "StorageAccountCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "default": "Microsoft.Storage/storageAccounts" + } + }, + "required": [ + "name" + ] + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." + }, + "reason": { + "type": "string", + "description": "Gets the reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": false + } + }, + "message": { + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + }, + "StorageAccountPropertiesCreateParameters": { + "properties": { + "accountType": { + "type": "string", + "description": "Gets or sets the account type.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + } + }, + "required": [ + "accountType" + ] + }, + "StorageAccountCreateParameters": { + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesCreateParameters" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "The parameters to provide for the account." + }, + "Endpoints": { + "properties": { + "blob": { + "type": "string", + "description": "Gets the blob endpoint." + }, + "queue": { + "type": "string", + "description": "Gets the queue endpoint." + }, + "table": { + "type": "string", + "description": "Gets the table endpoint." + }, + "file": { + "type": "string", + "description": "Gets the file endpoint." + } + }, + "description": "The URIs that are used to perform a retrieval of a public blob, queue or table object." + }, + "CustomDomain": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the custom domain name. Name is the CNAME source." + }, + "useSubDomain": { + "type": "boolean", + "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" + } + }, + "required": [ + "name" + ], + "description": "The custom domain assigned to this storage account. This can be set via Update." + }, + "StorageAccountProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Gets the status of the storage account at the time the operation was called.", + "enum": [ + "Creating", + "ResolvingDNS", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "accountType": { + "type": "string", + "description": "Gets the type of the storage account.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + }, + "primaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object.Note that StandardZRS and PremiumLRS accounts only return the blob endpoint." + }, + "primaryLocation": { + "type": "string", + "description": "Gets the location of the primary for the storage account." + }, + "statusOfPrimary": { + "type": "string", + "description": "Gets the status indicating whether the primary location of the storage account is available or unavailable.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "lastGeoFailoverTime": { + "type": "string", + "format": "date-time", + "description": "Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is StandardGRS or StandardRAGRS." + }, + "secondaryLocation": { + "type": "string", + "description": "Gets the location of the geo replicated secondary for the storage account. Only available if the accountType is StandardGRS or StandardRAGRS." + }, + "statusOfSecondary": { + "type": "string", + "description": "Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the accountType is StandardGRS or StandardRAGRS.", + "enum": [ + "Available", + "Unavailable" + ], + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": false + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets the creation date and time of the storage account in UTC." + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "Gets the user assigned custom domain assigned to this storage account." + }, + "secondaryEndpoints": { + "$ref": "#/definitions/Endpoints", + "description": "Gets the URLs that are used to perform a retrieval of a public blob, queue or table object from the secondary location of the storage account. Only available if the accountType is StandardRAGRS." + } + } + }, + "StorageAccount": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The storage account." + }, + "StorageAccountKeys": { + "properties": { + "key1": { + "type": "string", + "description": "Gets the value of key 1." + }, + "key2": { + "type": "string", + "description": "Gets the value of key 2." + } + }, + "description": "The access keys for the storage account." + }, + "StorageAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets the list of storage accounts and their properties." + } + }, + "description": "The list storage accounts operation response." + }, + "StorageAccountPropertiesUpdateParameters": { + "properties": { + "accountType": { + "type": "string", + "description": "Gets or sets the account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS.", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + }, + "customDomain": { + "$ref": "#/definitions/CustomDomain", + "description": "User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property." + } + } + }, + "StorageAccountUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageAccountPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true, + "description": "The parameters to update on the account." + }, + "StorageAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string" + } + }, + "required": [ + "keyName" + ] + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "Gets a string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "Gets a localized string describing the resource name." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "Gets the unit of measurement.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountsPerSecond", + "BytesPerSecond" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "Gets the current count of the allocated resources in the subscription." + }, + "limit": { + "type": "integer", + "format": "int32", + "description": "Gets the maximum count of the resources that can be allocated in the subscription." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "Gets the name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Storage Resource Usage." + }, + "UsageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "Gets or sets the list Storage Resource Usages." + } + }, + "description": "The List Usages operation response." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } } \ No newline at end of file diff --git a/arm-web/2015-08-01/swagger/service.json b/arm-web/2015-08-01/swagger/service.json index 47fde232f3a5..d46f6f89133e 100644 --- a/arm-web/2015-08-01/swagger/service.json +++ b/arm-web/2015-08-01/swagger/service.json @@ -1,20307 +1,20307 @@ -{ - "swagger": "2.0", - "info": { - "version": "2015-08-01", - "title": "WebSite Management Client", - "description": "Use these APIs to manage Azure Websites resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see Authenticating Azure Resource Manager requests." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": { - "get": { - "tags": [ - "Certificates" - ], - "summary": "Get certificates for a subscription in the specified resource group.", - "operationId": "Certificates_GetCertificates", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CertificateCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}": { - "get": { - "tags": [ - "Certificates" - ], - "summary": "Get a certificate by certificate name for a subscription in the specified resource group.", - "operationId": "Certificates_GetCertificate", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the certificate.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Certificate" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Certificates" - ], - "summary": "Creates or modifies an existing certificate.", - "operationId": "Certificates_CreateOrUpdateCertificate", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the certificate.", - "required": true, - "type": "string" - }, - { - "name": "certificateEnvelope", - "in": "body", - "description": "Details of certificate if it exists already.", - "required": true, - "schema": { - "$ref": "#/definitions/Certificate" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Certificate" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Certificates" - ], - "summary": "Delete a certificate by name in a specificed subscription and resourcegroup.", - "operationId": "Certificates_DeleteCertificate", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the certificate to be deleted.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Certificates" - ], - "summary": "Creates or modifies an existing certificate.", - "operationId": "Certificates_UpdateCertificate", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the certificate.", - "required": true, - "type": "string" - }, - { - "name": "certificateEnvelope", - "in": "body", - "description": "Details of certificate if it exists already.", - "required": true, - "schema": { - "$ref": "#/definitions/Certificate" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Certificate" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs": { - "get": { - "tags": [ - "Certificates" - ], - "summary": "Gets the certificate signing requests for a subscription in the specified resource group", - "operationId": "Certificates_GetCsrs", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Csr" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}": { - "get": { - "tags": [ - "Certificates" - ], - "summary": "Gets a certificate signing request by certificate name for a subscription in the specified resource group", - "operationId": "Certificates_GetCsr", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the certificate.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Csr" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Certificates" - ], - "summary": "Creates or modifies an existing certificate signing request.", - "operationId": "Certificates_CreateOrUpdateCsr", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the certificate.", - "required": true, - "type": "string" - }, - { - "name": "csrEnvelope", - "in": "body", - "description": "Details of certificate signing request if it exists already.", - "required": true, - "schema": { - "$ref": "#/definitions/Csr" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Csr" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Certificates" - ], - "summary": "Delete the certificate signing request.", - "operationId": "Certificates_DeleteCsr", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the certificate signing request.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Certificates" - ], - "summary": "Creates or modifies an existing certificate signing request.", - "operationId": "Certificates_UpdateCsr", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the certificate.", - "required": true, - "type": "string" - }, - { - "name": "csrEnvelope", - "in": "body", - "description": "Details of certificate signing request if it exists already.", - "required": true, - "schema": { - "$ref": "#/definitions/Csr" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Csr" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices": { - "get": { - "tags": [ - "ClassicMobileServices" - ], - "summary": "Get all mobile services in a resource group.", - "operationId": "ClassicMobileServices_GetClassicMobileServices", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClassicMobileServiceCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}": { - "get": { - "tags": [ - "ClassicMobileServices" - ], - "summary": "Get a mobile service.", - "operationId": "ClassicMobileServices_GetClassicMobileService", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of mobile service", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClassicMobileService" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "ClassicMobileServices" - ], - "summary": "Delete a mobile service.", - "operationId": "ClassicMobileServices_DeleteClassicMobileService", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of mobile service", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains": { - "get": { - "tags": [ - "Domains" - ], - "summary": "Lists domains under a resource group", - "operationId": "Domains_GetDomains", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DomainCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}": { - "get": { - "tags": [ - "Domains" - ], - "summary": "Gets details of a domain", - "operationId": "Domains_GetDomain", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "domainName", - "in": "path", - "description": "Name of the domain", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Domain" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Domains" - ], - "summary": "Creates a domain", - "operationId": "Domains_CreateOrUpdateDomain", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": ">Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "domainName", - "in": "path", - "description": "Name of the domain", - "required": true, - "type": "string" - }, - { - "name": "domain", - "in": "body", - "description": "Domain registration information", - "required": true, - "schema": { - "$ref": "#/definitions/Domain" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Domain purchase is in progress", - "schema": { - "$ref": "#/definitions/Domain" - } - }, - "200": { - "description": "Domain purchase was successful", - "schema": { - "$ref": "#/definitions/Domain" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Domains" - ], - "summary": "Deletes a domain", - "operationId": "Domains_DeleteDomain", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "domainName", - "in": "path", - "description": "Name of the domain", - "required": true, - "type": "string" - }, - { - "name": "forceHardDeleteDomain", - "in": "query", - "description": "If true then the domain will be deleted immediately instead of after 24 hours", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Domain does not exist in Azure database probably because it has already been deleted", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Domains" - ], - "summary": "Creates a domain", - "operationId": "Domains_UpdateDomain", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": ">Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "domainName", - "in": "path", - "description": "Name of the domain", - "required": true, - "type": "string" - }, - { - "name": "domain", - "in": "body", - "description": "Domain registration information", - "required": true, - "schema": { - "$ref": "#/definitions/Domain" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Domain purchase is in progress", - "schema": { - "$ref": "#/definitions/Domain" - } - }, - "200": { - "description": "Domain purchase was successful", - "schema": { - "$ref": "#/definitions/Domain" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}": { - "get": { - "tags": [ - "Domains" - ], - "summary": "Retrieves the latest status of a domain purchase operation", - "operationId": "Domains_GetDomainOperation", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "domainName", - "in": "path", - "description": "Name of the domain", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "Domain purchase operation Id", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Domain purchase is in progress", - "schema": { - "$ref": "#/definitions/Domain" - } - }, - "200": { - "description": "Domain purchase was successful", - "schema": { - "$ref": "#/definitions/Domain" - } - }, - "500": { - "description": "Domain purchase request failed" - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials": { - "get": { - "tags": [ - "Global" - ], - "summary": "Gets publishing credentials for the subscription owner", - "operationId": "Global_GetSubscriptionPublishingCredentials", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/User" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Global" - ], - "summary": "Updates publishing credentials for the subscription owner", - "operationId": "Global_UpdateSubscriptionPublishingCredentials", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "requestMessage", - "in": "body", - "description": "requestMessage with new publishing credentials", - "required": true, - "schema": { - "$ref": "#/definitions/User" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/User" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions": { - "get": { - "tags": [ - "Global" - ], - "summary": "Gets list of available geo regions", - "operationId": "Global_GetSubscriptionGeoRegions", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/GeoRegionCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates": { - "get": { - "tags": [ - "Global" - ], - "summary": "Get all certificates for a subscription", - "operationId": "Global_GetAllCertificates", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CertificateCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms": { - "get": { - "tags": [ - "Global" - ], - "summary": "Gets all App Service Plans for a subcription", - "operationId": "Global_GetAllServerFarms", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "detailed", - "in": "query", - "description": "False to return a subset of App Service Plan properties, true to return all of the properties.\r\n Retrieval of all properties may increase the API latency.", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": { - "get": { - "tags": [ - "Global" - ], - "summary": "Gets all Web Apps for a subscription", - "operationId": "Global_GetAllSites", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments": { - "get": { - "tags": [ - "Global" - ], - "summary": "Gets all hostingEnvironments (App Service Environment) for a subscription", - "operationId": "Global_GetAllHostingEnvironments", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostingEnvironmentCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/managedHostingEnvironments": { - "get": { - "tags": [ - "Global" - ], - "summary": "Gets all managed hosting environments for a subscription", - "operationId": "Global_GetAllManagedHostingEnvironments", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ManagedHostingEnvironmentCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/classicMobileServices": { - "get": { - "tags": [ - "Global" - ], - "summary": "Gets all mobile services for a subscription", - "operationId": "Global_GetAllClassicMobileServices", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClassicMobileServiceCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers": { - "get": { - "tags": [ - "Global" - ], - "summary": "List premier add on offers", - "operationId": "Global_ListPremierAddOnOffers", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable/{name}": { - "get": { - "tags": [ - "Global" - ], - "summary": "Whether hosting environment name is available", - "operationId": "Global_IsHostingEnvironmentWithLegacyNameAvailable", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Hosting environment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable": { - "get": { - "tags": [ - "Global" - ], - "summary": "Whether hosting environment name is available", - "operationId": "Global_IsHostingEnvironmentNameAvailable", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "name", - "in": "query", - "description": "Hosting environment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability": { - "post": { - "tags": [ - "Global" - ], - "summary": "Check if resource name is available", - "operationId": "Global_CheckNameAvailability", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "request", - "in": "body", - "description": "Name availability request", - "required": true, - "schema": { - "$ref": "#/definitions/ResourceNameAvailabilityRequest" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResourceNameAvailability" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains": { - "get": { - "tags": [ - "GlobalDomainRegistration" - ], - "summary": "Lists all domains in a subscription", - "operationId": "GlobalDomainRegistration_GetAllDomains", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DomainCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest": { - "post": { - "tags": [ - "GlobalDomainRegistration" - ], - "summary": "Generates a single sign on request for domain management portal", - "operationId": "GlobalDomainRegistration_GetDomainControlCenterSsoRequest", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DomainControlCenterSsoRequest" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/validateDomainRegistrationInformation": { - "post": { - "tags": [ - "GlobalDomainRegistration" - ], - "summary": "Validates domain registration information", - "operationId": "GlobalDomainRegistration_ValidateDomainPurchaseInformation", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "domainRegistrationInput", - "in": "body", - "description": "Domain registration information", - "required": true, - "schema": { - "$ref": "#/definitions/DomainRegistrationInput" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability": { - "post": { - "tags": [ - "GlobalDomainRegistration" - ], - "summary": "Checks if a domain is available for registration", - "operationId": "GlobalDomainRegistration_CheckDomainAvailability", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "identifier", - "in": "body", - "description": "Name of the domain", - "required": true, - "schema": { - "$ref": "#/definitions/NameIdentifier" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DomainAvailablilityCheckResult" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations": { - "post": { - "tags": [ - "GlobalDomainRegistration" - ], - "summary": "Lists domain recommendations based on keywords", - "operationId": "GlobalDomainRegistration_ListDomainRecommendations", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Domain recommendation search parameters", - "required": true, - "schema": { - "$ref": "#/definitions/DomainRecommendationSearchParameters" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NameIdentifierCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": { - "post": { - "tags": [ - "GlobalResourceGroups" - ], - "operationId": "GlobalResourceGroups_MoveResources", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "moveResourceEnvelope", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CsmMoveResourceEnvelope" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "204": { - "description": "No Content" - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get properties of hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostingEnvironment" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Create or update a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_CreateOrUpdateHostingEnvironment", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "hostingEnvironmentEnvelope", - "in": "body", - "description": "Properties of hostingEnvironment (App Service Environment)", - "required": true, - "schema": { - "$ref": "#/definitions/HostingEnvironment" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostingEnvironment" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/HostingEnvironment" - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Delete a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_DeleteHostingEnvironment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "forceDelete", - "in": "query", - "description": "Delete even if the hostingEnvironment (App Service Environment) contains resources", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get diagnostic information for hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentDiagnostics", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/HostingEnvironmentDiagnostics" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get diagnostic information for hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentDiagnosticsItem", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "diagnosticsName", - "in": "path", - "description": "Name of the diagnostics", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostingEnvironmentDiagnostics" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get used, available, and total worker capacity for hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentCapacities", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StampCapacityCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get IP addresses assigned to the hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentVips", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AddressResponse" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get all hostingEnvironments (App Service Environments) in a resource group.", - "operationId": "HostingEnvironments_GetHostingEnvironments", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostingEnvironmentCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": { - "post": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Reboots all machines in a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_RebootHostingEnvironment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Asynchronous operation in progress", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "List all currently running operations on the hostingEnvironment (App Service Environment)", - "operationId": "HostingEnvironments_GetHostingEnvironmentOperations", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get status of an operation on a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentOperation", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "operation identifier GUID", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "202": { - "description": "Asynchronous operation in progress", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "404": { - "description": "Not found" - }, - "500": { - "description": "Operation failed" - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get global metrics of hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMetrics", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "details", - "in": "query", - "description": "Include instance details", - "type": "boolean" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResourceMetricCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get global metric definitions of hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMetricDefinitions", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetricDefinition" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get global usages of hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentUsages", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CsmUsageQuotaCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get metrics for a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "startTime", - "in": "query", - "description": "Beginning time of metrics query", - "type": "string" - }, - { - "name": "endTime", - "in": "query", - "description": "End time of metrics query", - "type": "string" - }, - { - "name": "timeGrain", - "in": "query", - "description": "Time granularity of metrics query", - "type": "string" - }, - { - "name": "details", - "in": "query", - "description": "Include instance details", - "type": "boolean" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResourceMetricCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get metrics for a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerMetrics", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, - "type": "string" - }, - { - "name": "details", - "in": "query", - "description": "Include instance details", - "type": "boolean" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResourceMetricCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get metric definitions for a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleMetricDefinitions", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get metric definitions for a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get usages for a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleUsages", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/UsageCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get usages for a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerUsages", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/UsageCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get all sites on the hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentSites", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "propertiesToInclude", - "in": "query", - "description": "Comma separated list of site properties to include", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentWebHostingPlans", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentServerFarms", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get all multi role pools", - "operationId": "HostingEnvironments_GetMultiRolePools", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkerPoolCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get properties of a multiRool pool.", - "operationId": "HostingEnvironments_GetMultiRolePool", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkerPool" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Create or update a multiRole pool.", - "operationId": "HostingEnvironments_CreateOrUpdateMultiRolePool", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "multiRolePoolEnvelope", - "in": "body", - "description": "Properties of multiRole pool", - "required": true, - "schema": { - "$ref": "#/definitions/WorkerPool" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkerPool" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/WorkerPool" - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get available skus for scaling a multiRole pool.", - "operationId": "HostingEnvironments_GetMultiRolePoolSkus", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SkuInfoCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get all worker pools", - "operationId": "HostingEnvironments_GetWorkerPools", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkerPoolCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get properties of a worker pool.", - "operationId": "HostingEnvironments_GetWorkerPool", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkerPool" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Create or update a worker pool.", - "operationId": "HostingEnvironments_CreateOrUpdateWorkerPool", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, - "type": "string" - }, - { - "name": "workerPoolEnvelope", - "in": "body", - "description": "Properties of worker pool", - "required": true, - "schema": { - "$ref": "#/definitions/WorkerPool" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkerPool" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/WorkerPool" - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get available skus for scaling a worker pool.", - "operationId": "HostingEnvironments_GetWorkerPoolSkus", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SkuInfoCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get metrics for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetWorkerPoolInstanceMetrics", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, - "type": "string" - }, - { - "name": "instance", - "in": "path", - "description": "Name of instance in the worker pool", - "required": true, - "type": "string" - }, - { - "name": "details", - "in": "query", - "description": "Include instance details", - "type": "boolean" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get metric definitions for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetWorkerPoolInstanceMetricDefinitions", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, - "type": "string" - }, - { - "name": "instance", - "in": "path", - "description": "Name of instance in the worker pool", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get metrics for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetMultiRolePoolInstanceMetrics", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "instance", - "in": "path", - "description": "Name of instance in the multiRole pool", - "required": true, - "type": "string" - }, - { - "name": "details", - "in": "query", - "description": "Include instance details", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions": { - "get": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Get metric definitions for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetMultiRolePoolInstanceMetricDefinitions", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "instance", - "in": "path", - "description": "Name of instance in the multiRole pool>", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend": { - "post": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Suspends the hostingEnvironment.", - "operationId": "HostingEnvironments_SuspendHostingEnvironment", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume": { - "post": { - "tags": [ - "HostingEnvironments" - ], - "summary": "Resumes the hostingEnvironment.", - "operationId": "HostingEnvironments_ResumeHostingEnvironment", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}": { - "get": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Get properties of a managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ManagedHostingEnvironment" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Create or update a managed hosting environment.", - "operationId": "ManagedHostingEnvironments_CreateOrUpdateManagedHostingEnvironment", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "name": "ManagedHostingEnvironmentEnvelope", - "in": "body", - "description": "Properties of managed hosting environment", - "required": true, - "schema": { - "$ref": "#/definitions/HostingEnvironment" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Asynchronous operation in progress", - "schema": { - "$ref": "#/definitions/HostingEnvironment" - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Delete a managed hosting environment.", - "operationId": "ManagedHostingEnvironments_DeleteManagedHostingEnvironment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "name": "forceDelete", - "in": "query", - "description": "Delete even if the managed hosting environment contains resources", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Asynchronous operation in progress", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments": { - "get": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Get all managed hosting environments in a resource group.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironments", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostingEnvironmentCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/capacities/virtualip": { - "get": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Get list of ip addresses assigned to a managed hosting environment", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentVips", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AddressResponse" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/operations/{operationId}": { - "get": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Get status of an operation on a managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentOperation", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "operation identifier GUID", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation completed successfully", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "202": { - "description": "Asynchronous operation in progress", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "404": { - "description": "Not found" - }, - "500": { - "description": "Operation failed" - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites": { - "get": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Get all sites on the managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentSites", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "name": "propertiesToInclude", - "in": "query", - "description": "Comma separated list of site properties to include", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/webhostingplans": { - "get": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Get all serverfarms (App Service Plans) on the managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentWebHostingPlans", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/serverfarms": { - "get": { - "tags": [ - "ManagedHostingEnvironments" - ], - "summary": "Get all serverfarms (App Service Plans) on the managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentServerFarms", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmCollection" - } - } - }, - "deprecated": false - } - }, - "/providers/Microsoft.Web/sourcecontrols": { - "get": { - "tags": [ - "Provider" - ], - "summary": "Gets the source controls available for Azure websites", - "operationId": "Provider_GetSourceControls", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SourceControlCollection" - } - } - }, - "deprecated": false - } - }, - "/providers/Microsoft.Web/sourcecontrols/{sourceControlType}": { - "get": { - "tags": [ - "Provider" - ], - "summary": "Gets source control token", - "operationId": "Provider_GetSourceControl", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "sourceControlType", - "in": "path", - "description": "Type of source control", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SourceControl" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Provider" - ], - "summary": "Updates source control token", - "operationId": "Provider_UpdateSourceControl", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "sourceControlType", - "in": "path", - "description": "Type of source control", - "required": true, - "type": "string" - }, - { - "name": "requestMessage", - "in": "body", - "description": "Source control token information", - "required": true, - "schema": { - "$ref": "#/definitions/SourceControl" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SourceControl" - } - } - }, - "deprecated": false - } - }, - "/providers/Microsoft.Web/publishingUsers/web": { - "get": { - "tags": [ - "Provider" - ], - "summary": "Gets publishing user", - "operationId": "Provider_GetPublishingUser", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/User" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Provider" - ], - "summary": "Updates publishing user", - "operationId": "Provider_UpdatePublishingUser", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "requestMessage", - "in": "body", - "description": "Details of publishing user", - "required": true, - "schema": { - "$ref": "#/definitions/User" - } - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/User" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations": { - "get": { - "tags": [ - "Recommendations" - ], - "summary": "Gets a list of recommendations associated with the specified subscription.", - "operationId": "Recommendations_GetRecommendationBySubscription", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "featured", - "in": "query", - "description": "If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available", - "type": "boolean" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification'", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Recommendation" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}": { - "get": { - "tags": [ - "Recommendations" - ], - "summary": "Gets the detailed properties of the recommendation object for the specified web site.", - "operationId": "Recommendations_GetRuleDetailsBySiteName", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "siteName", - "in": "path", - "description": "Site name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Recommendation rule name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RecommendationRule" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations": { - "get": { - "tags": [ - "Recommendations" - ], - "summary": "Gets a list of recommendations associated with the specified web site.", - "operationId": "Recommendations_GetRecommendedRulesForSite", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "siteName", - "in": "path", - "description": "Site name", - "required": true, - "type": "string" - }, - { - "name": "featured", - "in": "query", - "description": "If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available", - "type": "boolean" - }, - { - "name": "siteSku", - "in": "query", - "description": "The name of site SKU.", - "type": "string" - }, - { - "name": "numSlots", - "in": "query", - "description": "The number of site slots associated to the site", - "type": "integer", - "format": "int32" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Recommendation" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory": { - "get": { - "tags": [ - "Recommendations" - ], - "summary": "Gets the list of past recommendations optionally specified by the time range.", - "operationId": "Recommendations_GetRecommendationHistoryForSite", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "siteName", - "in": "path", - "description": "Site name", - "required": true, - "type": "string" - }, - { - "name": "startTime", - "in": "query", - "description": "The start time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z'", - "type": "string" - }, - { - "name": "endTime", - "in": "query", - "description": "The end time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z'", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Recommendation" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets collection of App Service Plans in a resource group for a given subscription.", - "operationId": "ServerFarms_GetServerFarms", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets specified App Service Plan in a resource group", - "operationId": "ServerFarms_GetServerFarm", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "ServerFarms" - ], - "summary": "Creates or updates an App Service Plan", - "operationId": "ServerFarms_CreateOrUpdateServerFarm", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "serverFarmEnvelope", - "in": "body", - "description": "Details of App Service Plan", - "required": true, - "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" - } - }, - { - "name": "allowPendingState", - "in": "query", - "description": "OBSOLETE: If true, allow pending state for App Service Plan", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "ServerFarms" - ], - "summary": "Deletes a App Service Plan", - "operationId": "ServerFarms_DeleteServerFarm", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Queries for App Serice Plan metrics", - "operationId": "ServerFarms_GetServerFarmMetrics", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "details", - "in": "query", - "description": "If true, metrics are broken down per App Service Plan instance", - "type": "boolean" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResourceMetricCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "List of metrics that can be queried for an App Service Plan", - "operationId": "ServerFarms_GetServerFarmMetricDefintions", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets list of vnets associated with App Service Plan", - "operationId": "ServerFarms_GetVnetsForServerFarm", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetInfo" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets a vnet associated with an App Service Plan", - "operationId": "ServerFarms_GetVnetFromServerFarm", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of virtual network", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetInfo" - } - }, - "404": { - "description": "Virtual network could not be found" - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets a list of all routes associated with a vnet, in an app service plan", - "operationId": "ServerFarms_GetRoutesForVnet", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of virtual network", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetRoute" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets a specific route associated with a vnet, in an app service plan", - "operationId": "ServerFarms_GetRouteForVnet", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of virtual network", - "required": true, - "type": "string" - }, - { - "name": "routeName", - "in": "path", - "description": "Name of the virtual network route", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetRoute" - } - } - }, - "404": { - "description": "Specified route does not exist" - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "ServerFarms" - ], - "summary": "Creates a new route or updates an existing route for a vnet in an app service plan.", - "operationId": "ServerFarms_CreateOrUpdateVnetRoute", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of virtual network", - "required": true, - "type": "string" - }, - { - "name": "routeName", - "in": "path", - "description": "Name of the virtual network route", - "required": true, - "type": "string" - }, - { - "name": "route", - "in": "body", - "description": "The route object", - "required": true, - "schema": { - "$ref": "#/definitions/VnetRoute" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetRoute" - } - }, - "400": { - "description": "Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid" - }, - "404": { - "description": "Route not found. This will only occur when using the PATCH verb." - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "ServerFarms" - ], - "summary": "Deletes an existing route for a vnet in an app service plan.", - "operationId": "ServerFarms_DeleteVnetRoute", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of virtual network", - "required": true, - "type": "string" - }, - { - "name": "routeName", - "in": "path", - "description": "Name of the virtual network route", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "404": { - "description": "Specified route does not exist." - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "ServerFarms" - ], - "summary": "Creates a new route or updates an existing route for a vnet in an app service plan.", - "operationId": "ServerFarms_UpdateVnetRoute", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of virtual network", - "required": true, - "type": "string" - }, - { - "name": "routeName", - "in": "path", - "description": "Name of the virtual network route", - "required": true, - "type": "string" - }, - { - "name": "route", - "in": "body", - "description": "The route object", - "required": true, - "schema": { - "$ref": "#/definitions/VnetRoute" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetRoute" - } - }, - "400": { - "description": "Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid" - }, - "404": { - "description": "Route not found. This will only occur when using the PATCH verb." - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets the vnet gateway.", - "operationId": "ServerFarms_GetServerFarmVnetGateway", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "Name of the virtual network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", - "in": "path", - "description": "Name of the gateway. Only the 'primary' gateway is supported.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetGateway" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "ServerFarms" - ], - "summary": "Updates the vnet gateway", - "operationId": "ServerFarms_UpdateServerFarmVnetGateway", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the virtual network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", - "in": "path", - "description": "The name of the gateway. Only 'primary' is supported.", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The gateway entity.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetGateway" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets list of Apps associated with an App Service Plan", - "operationId": "ServerFarms_GetServerFarmSites", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Skip to of web apps in a list. If specified, the resulting list will contain web apps starting from (including) the skipToken. Else, the resulting list contains web apps from the start of the list", - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Supported filter: $filter=state eq running. Returns only web apps that are currently running", - "type": "string" - }, - { - "name": "$top", - "in": "query", - "description": "List page size. If specified, results are paged.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot": { - "post": { - "tags": [ - "ServerFarms" - ], - "summary": "Submit a reboot request for a worker machine in the specified server farm", - "operationId": "ServerFarms_RebootWorkerForServerFarm", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of server farm", - "required": true, - "type": "string" - }, - { - "name": "workerName", - "in": "path", - "description": "Name of worker machine, typically starts with RD", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites": { - "post": { - "tags": [ - "ServerFarms" - ], - "summary": "Restarts web apps in a specified App Service Plan", - "operationId": "ServerFarms_RestartSitesForServerFarm", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of App Service Plan", - "required": true, - "type": "string" - }, - { - "name": "softRestart", - "in": "query", - "description": "Soft restart applies the configuration settings and restarts the apps if necessary. Hard restart always restarts and reprovisions the apps", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}": { - "get": { - "tags": [ - "ServerFarms" - ], - "summary": "Gets a server farm operation", - "operationId": "ServerFarms_GetServerFarmOperation", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of server farm", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "Id of Server farm operation\">", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a list of all Virtual Network Connections associated with this web app.", - "operationId": "Sites_GetSiteVNETConnections", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetInfo" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a list of all Virtual Network Connections associated with this web app.", - "operationId": "Sites_GetSiteVNETConnectionsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetInfo" - } - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a specific Virtual Network Connection associated with this web app.", - "operationId": "Sites_GetSiteVNETConnectionSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetInfo" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Adds a Virtual Network Connection or updates it's properties.", - "operationId": "Sites_CreateOrUpdateSiteVNETConnectionSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties of this Virtual Network Connection", - "required": true, - "schema": { - "$ref": "#/definitions/VnetInfo" - } - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetInfo" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Removes the specified Virtual Network Connection association from this web app.", - "operationId": "Sites_DeleteSiteVNETConnectionSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Adds a Virtual Network Connection or updates it's properties.", - "operationId": "Sites_UpdateSiteVNETConnectionSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties of this Virtual Network Connection", - "required": true, - "schema": { - "$ref": "#/definitions/VnetInfo" - } - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetInfo" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a specific Virtual Network Connection associated with this web app.", - "operationId": "Sites_GetSiteVNETConnection", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetInfo" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Adds a Virtual Network Connection or updates it's properties.", - "operationId": "Sites_CreateOrUpdateSiteVNETConnection", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties of this Virtual Network Connection", - "required": true, - "schema": { - "$ref": "#/definitions/VnetInfo" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetInfo" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Removes the specified Virtual Network Connection association from this web app.", - "operationId": "Sites_DeleteSiteVNETConnection", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Adds a Virtual Network Connection or updates it's properties.", - "operationId": "Sites_UpdateSiteVNETConnection", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties of this Virtual Network Connection", - "required": true, - "schema": { - "$ref": "#/definitions/VnetInfo" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetInfo" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a view of all network features in use on this web app.", - "operationId": "Sites_GetSiteNetworkFeaturesSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "view", - "in": "path", - "description": "The type of view. This can either be \"summary\" or \"detailed\".", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NetworkFeatures" - } - }, - "404": { - "description": "The requested view does not exist." - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a view of all network features in use on this web app.", - "operationId": "Sites_GetSiteNetworkFeatures", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "view", - "in": "path", - "description": "The type of view. This can either be \"summary\" or \"detailed\".", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NetworkFeatures" - } - }, - "404": { - "description": "The requested view does not exist." - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/operationresults/{operationId}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the operation for a web app", - "operationId": "Sites_GetSiteOperationSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "Id of an operation", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/operationresults/{operationId}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the operation for a web app", - "operationId": "Sites_GetSiteOperation", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "Id of an operation", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Swaps web app slots", - "operationId": "Sites_SwapSlotWithProduction", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slotSwapEntity", - "in": "body", - "description": "Request body that contains the target slot name", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Swaps web app slots", - "operationId": "Sites_SwapSlotsSlot", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slotSwapEntity", - "in": "body", - "description": "Request body that contains the target slot name", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of source slot for the swap", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Get the difference in configuration settings between two web app slots", - "operationId": "Sites_GetSlotsDifferencesFromProduction", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slotSwapEntity", - "in": "body", - "description": "Request body that contains the target slot name", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SlotDifferenceCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Get the difference in configuration settings between two web app slots", - "operationId": "Sites_GetSlotsDifferencesSlot", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slotSwapEntity", - "in": "body", - "description": "Request body that contains the target slot name", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of the source slot", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SlotDifferenceCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Applies the configuration settings from the target slot onto the current slot", - "operationId": "Sites_ApplySlotConfigToProduction", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slotSwapEntity", - "in": "body", - "description": "Request body that contains the target slot name. Settings from that slot will be applied on the source slot", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Applies the configuration settings from the target slot onto the current slot", - "operationId": "Sites_ApplySlotConfigSlot", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slotSwapEntity", - "in": "body", - "description": "Request body that contains the target slot name. Settings from that slot will be applied on the source slot", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSlotEntity" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of the source slot. Settings from the target slot will be applied onto this slot", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Resets the configuration settings of the current slot if they were previously modified by calling ApplySlotConfig API", - "operationId": "Sites_ResetProductionSlotConfig", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Resets the configuration settings of the current slot if they were previously modified by calling ApplySlotConfig API", - "operationId": "Sites_ResetSlotConfigSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the names of application settings and connection string that remain with the slot during swap operation", - "operationId": "Sites_GetSlotConfigNames", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SlotConfigNamesResource" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the names of application settings and connection string that remain with the slot during swap operation", - "operationId": "Sites_UpdateSlotConfigNames", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slotConfigNames", - "in": "body", - "description": "Request body containing the names of application settings and connection strings", - "required": true, - "schema": { - "$ref": "#/definitions/SlotConfigNamesResource" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SlotConfigNamesResource" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets all the slots for a web apps", - "operationId": "Sites_GetSiteSlots", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "propertiesToInclude", - "in": "query", - "description": "List of app properties to include in the response", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the web apps for a subscription in the specified resource group", - "operationId": "Sites_GetSites", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "propertiesToInclude", - "in": "query", - "description": "Additional web app properties included in the response", - "type": "string" - }, - { - "name": "includeSiteTypes", - "in": "query", - "description": "Types of apps included in the response", - "type": "string" - }, - { - "name": "includeSlots", - "in": "query", - "description": "Whether or not to include deployments slots in results", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get details of a web app", - "operationId": "Sites_GetSite", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "propertiesToInclude", - "in": "query", - "description": "Additional web app properties included in the response", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Site" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Creates a new web app or modifies an existing web app.", - "operationId": "Sites_CreateOrUpdateSite", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the web app", - "required": true, - "type": "string" - }, - { - "name": "siteEnvelope", - "in": "body", - "description": "Details of web app if it exists already", - "required": true, - "schema": { - "$ref": "#/definitions/Site" - } - }, - { - "name": "skipDnsRegistration", - "in": "query", - "description": "If true web app hostname is not registered with DNS on creation. This parameter is\r\n only used for app creation", - "type": "string" - }, - { - "name": "skipCustomDomainVerification", - "in": "query", - "description": "If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.", - "type": "string" - }, - { - "name": "forceDnsRegistration", - "in": "query", - "description": "If true, web app hostname is force registered with DNS", - "type": "string" - }, - { - "name": "ttlInSeconds", - "in": "query", - "description": "Time to live in seconds for web app's default domain name", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Site" - } - }, - "202": { - "description": "Asynchronous operation in progress", - "schema": { - "$ref": "#/definitions/Site" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Deletes a web app", - "operationId": "Sites_DeleteSite", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "deleteMetrics", - "in": "query", - "description": "If true, web app metrics are also deleted", - "type": "string" - }, - { - "name": "deleteEmptyServerFarm", - "in": "query", - "description": "If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted", - "type": "string" - }, - { - "name": "skipDnsRegistration", - "in": "query", - "description": "If true, DNS registration is skipped", - "type": "string" - }, - { - "name": "deleteAllSlots", - "in": "query", - "description": "If true, all slots associated with web app are also deleted", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get details of a web app", - "operationId": "Sites_GetSiteSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "propertiesToInclude", - "in": "query", - "description": "Additional web app properties included in the response", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Site" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Creates a new web app or modifies an existing web app.", - "operationId": "Sites_CreateOrUpdateSiteSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the web app", - "required": true, - "type": "string" - }, - { - "name": "siteEnvelope", - "in": "body", - "description": "Details of web app if it exists already", - "required": true, - "schema": { - "$ref": "#/definitions/Site" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "skipDnsRegistration", - "in": "query", - "description": "If true web app hostname is not registered with DNS on creation. This parameter is\r\n only used for app creation", - "type": "string" - }, - { - "name": "skipCustomDomainVerification", - "in": "query", - "description": "If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.", - "type": "string" - }, - { - "name": "forceDnsRegistration", - "in": "query", - "description": "If true, web app hostname is force registered with DNS", - "type": "string" - }, - { - "name": "ttlInSeconds", - "in": "query", - "description": "Time to live in seconds for web app's default domain name", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Site" - } - }, - "202": { - "description": "Asynchronous operation in progress", - "schema": { - "$ref": "#/definitions/Site" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Deletes a web app", - "operationId": "Sites_DeleteSiteSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "deleteMetrics", - "in": "query", - "description": "If true, web app metrics are also deleted", - "type": "string" - }, - { - "name": "deleteEmptyServerFarm", - "in": "query", - "description": "If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted", - "type": "string" - }, - { - "name": "skipDnsRegistration", - "in": "query", - "description": "If true, DNS registration is skipped", - "type": "string" - }, - { - "name": "deleteAllSlots", - "in": "query", - "description": "If true, all slots associated with web app are also deleted", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Creates a new web app or modifies an existing web app.", - "operationId": "Sites_IsSiteCloneable", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCloneability" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Creates a new web app or modifies an existing web app.", - "operationId": "Sites_IsSiteCloneableSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of the web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteCloneability" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Recovers a deleted web app", - "operationId": "Sites_RecoverSite", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "snapshot", - "in": "body", - "description": "Snapshot data used for web app recovery. Snapshot information can be obtained by call GetDeletedSites API.", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSiteRecoveryEntity" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Recovers a deleted web app", - "operationId": "Sites_RecoverSiteSlot", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "snapshot", - "in": "body", - "description": "Snapshot data used for web app recovery. Snapshot information can be obtained by call GetDeletedSites API.", - "required": true, - "schema": { - "$ref": "#/definitions/CsmSiteRecoveryEntity" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restorableSnapshots": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Returns Snapshots to the user based on their SKU.", - "operationId": "Sites_GetSiteSnapshotsOnSkuSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "subscriptionName", - "in": "query", - "description": "Azure subscription", - "required": true, - "type": "string" - }, - { - "name": "webspaceName", - "in": "query", - "description": "Webspace", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Website Name", - "required": true, - "type": "string" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restorableSnapshots": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Returns Snapshots to the user based on their SKU.", - "operationId": "Sites_GetSiteSnapshotsOnSku", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "subscriptionName", - "in": "query", - "description": "Azure subscription", - "required": true, - "type": "string" - }, - { - "name": "webspaceName", - "in": "query", - "description": "Webspace", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Website Name", - "required": true, - "type": "string" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Returns all Snapshots to the user.", - "operationId": "Sites_GetSiteSnapshots", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "subscriptionName", - "in": "query", - "description": "Azure subscription", - "required": true, - "type": "string" - }, - { - "name": "webspaceName", - "in": "query", - "description": "Webspace", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Website Name", - "required": true, - "type": "string" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Returns all Snapshots to the user.", - "operationId": "Sites_GetSiteSnapshotsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "subscriptionName", - "in": "query", - "description": "Azure subscription", - "required": true, - "type": "string" - }, - { - "name": "webspaceName", - "in": "query", - "description": "Webspace", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Website Name", - "required": true, - "type": "string" - }, - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/deletedSites": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets deleted web apps in subscription", - "operationId": "Sites_GetDeletedSites", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "propertiesToInclude", - "in": "query", - "description": "Additional web app properties included in the response", - "type": "string" - }, - { - "name": "includeSiteTypes", - "in": "query", - "description": "Types of apps included in the response", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeletedSiteCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { - "get": { - "tags": [ - "Sites" - ], - "summary": "List deployments", - "operationId": "Sites_GetDeploymentsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeploymentCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": { - "get": { - "tags": [ - "Sites" - ], - "summary": "List deployments", - "operationId": "Sites_GetDeployments", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeploymentCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments": { - "get": { - "tags": [ - "Sites" - ], - "summary": "List deployments", - "operationId": "Sites_GetInstanceDeployments", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "Id of web app instance", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeploymentCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments": { - "get": { - "tags": [ - "Sites" - ], - "summary": "List deployments", - "operationId": "Sites_GetInstanceDeploymentsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "Id of web app instance", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeploymentCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get the deployment", - "operationId": "Sites_GetInstanceDeploymentSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "Id of web app instance", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Create a deployment", - "operationId": "Sites_CreateInstanceDeploymentSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "Id of web app instance", - "required": true, - "type": "string" - }, - { - "name": "deployment", - "in": "body", - "description": "Details of deployment", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Delete the deployment", - "operationId": "Sites_DeleteInstanceDeploymentSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "Id of web app instance", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get the deployment", - "operationId": "Sites_GetDeployment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Create a deployment", - "operationId": "Sites_CreateDeployment", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "deployment", - "in": "body", - "description": "Details of deployment", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Delete the deployment", - "operationId": "Sites_DeleteDeployment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get the deployment", - "operationId": "Sites_GetDeploymentSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Create a deployment", - "operationId": "Sites_CreateDeploymentSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "deployment", - "in": "body", - "description": "Details of deployment", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Delete the deployment", - "operationId": "Sites_DeleteDeploymentSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get the deployment", - "operationId": "Sites_GetInstanceDeployment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "Id of web app instance", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Create a deployment", - "operationId": "Sites_CreateInstanceDeployment", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "Id of web app instance", - "required": true, - "type": "string" - }, - { - "name": "deployment", - "in": "body", - "description": "Details of deployment", - "required": true, - "schema": { - "$ref": "#/definitions/Deployment" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Deployment" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Delete the deployment", - "operationId": "Sites_DeleteInstanceDeployment", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "id", - "in": "path", - "description": "Id of the deployment", - "required": true, - "type": "string" - }, - { - "name": "instanceId", - "in": "path", - "description": "Id of web app instance", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets all instance of a web app", - "operationId": "Sites_GetSiteInstanceIdentifiers", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteInstanceCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets all instance of a web app", - "operationId": "Sites_GetSiteInstanceIdentifiersSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteInstanceCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get web app hostname bindings", - "operationId": "Sites_GetSiteHostNameBindings", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostNameBindingCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get web app hostname bindings", - "operationId": "Sites_GetSiteHostNameBindingsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostNameBindingCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get web app binding for a hostname", - "operationId": "Sites_GetSiteHostNameBinding", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "hostName", - "in": "path", - "description": "Name of host", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostNameBinding" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Creates a web app hostname binding", - "operationId": "Sites_CreateOrUpdateSiteHostNameBinding", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "hostName", - "in": "path", - "description": "Name of host", - "required": true, - "type": "string" - }, - { - "name": "hostNameBinding", - "in": "body", - "description": "Host name binding information", - "required": true, - "schema": { - "$ref": "#/definitions/HostNameBinding" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostNameBinding" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Deletes a host name binding", - "operationId": "Sites_DeleteSiteHostNameBinding", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "hostName", - "in": "path", - "description": "Name of host", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get web app binding for a hostname", - "operationId": "Sites_GetSiteHostNameBindingSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "hostName", - "in": "path", - "description": "Name of host", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostNameBinding" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Creates a web app hostname binding", - "operationId": "Sites_CreateOrUpdateSiteHostNameBindingSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "hostName", - "in": "path", - "description": "Name of host", - "required": true, - "type": "string" - }, - { - "name": "hostNameBinding", - "in": "body", - "description": "Host name binding information", - "required": true, - "schema": { - "$ref": "#/definitions/HostNameBinding" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/HostNameBinding" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Deletes a host name binding", - "operationId": "Sites_DeleteSiteHostNameBindingSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "hostName", - "in": "path", - "description": "Name of host", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the configuration of the web app", - "operationId": "Sites_GetSiteConfig", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfig" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Update the configuration of web app", - "operationId": "Sites_CreateOrUpdateSiteConfig", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteConfig", - "in": "body", - "description": "Request body that contains the configuraiton setting for the web app", - "required": true, - "schema": { - "$ref": "#/definitions/SiteConfig" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfig" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Update the configuration of web app", - "operationId": "Sites_UpdateSiteConfig", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteConfig", - "in": "body", - "description": "Request body that contains the configuraiton setting for the web app", - "required": true, - "schema": { - "$ref": "#/definitions/SiteConfig" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfig" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the configuration of the web app", - "operationId": "Sites_GetSiteConfigSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfig" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Update the configuration of web app", - "operationId": "Sites_CreateOrUpdateSiteConfigSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteConfig", - "in": "body", - "description": "Request body that contains the configuraiton setting for the web app", - "required": true, - "schema": { - "$ref": "#/definitions/SiteConfig" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfig" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Update the configuration of web app", - "operationId": "Sites_UpdateSiteConfigSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteConfig", - "in": "body", - "description": "Request body that contains the configuraiton setting for the web app", - "required": true, - "schema": { - "$ref": "#/definitions/SiteConfig" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteConfig" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get the source control configuration of web app", - "operationId": "Sites_GetSiteSourceControlSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Update the source control configuration of web app", - "operationId": "Sites_CreateOrUpdateSiteSourceControlSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteSourceControl", - "in": "body", - "description": "Request body that contains the source control parameters", - "required": true, - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Delete source control configuration of web app", - "operationId": "Sites_DeleteSiteSourceControlSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Update the source control configuration of web app", - "operationId": "Sites_UpdateSiteSourceControlSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteSourceControl", - "in": "body", - "description": "Request body that contains the source control parameters", - "required": true, - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Get the source control configuration of web app", - "operationId": "Sites_GetSiteSourceControl", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Update the source control configuration of web app", - "operationId": "Sites_CreateOrUpdateSiteSourceControl", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteSourceControl", - "in": "body", - "description": "Request body that contains the source control parameters", - "required": true, - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Delete source control configuration of web app", - "operationId": "Sites_DeleteSiteSourceControl", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Update the source control configuration of web app", - "operationId": "Sites_UpdateSiteSourceControl", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteSourceControl", - "in": "body", - "description": "Request body that contains the source control parameters", - "required": true, - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the application settings of web app", - "operationId": "Sites_ListSiteAppSettings", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the application settings of web app", - "operationId": "Sites_ListSiteAppSettingsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the application settings of web app", - "operationId": "Sites_UpdateSiteAppSettings", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "appSettings", - "in": "body", - "description": "Application settings of web app", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the application settings of web app", - "operationId": "Sites_UpdateSiteAppSettingsSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "appSettings", - "in": "body", - "description": "Application settings of web app", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the connection strings associated with web app", - "operationId": "Sites_ListSiteConnectionStrings", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the connection strings associated with web app", - "operationId": "Sites_ListSiteConnectionStringsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the connection strings associated with web app", - "operationId": "Sites_UpdateSiteConnectionStrings", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "connectionStrings", - "in": "body", - "description": "Connection strings associated with web app", - "required": true, - "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the connection strings associated with web app", - "operationId": "Sites_UpdateSiteConnectionStringsSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "connectionStrings", - "in": "body", - "description": "Connection strings associated with web app", - "required": true, - "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the Authentication / Authorization settings associated with web app", - "operationId": "Sites_ListSiteAuthSettings", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteAuthSettings" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the Authentication / Authorization settings associated with web app", - "operationId": "Sites_ListSiteAuthSettingsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteAuthSettings" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the Authentication / Authorization settings associated with web app", - "operationId": "Sites_UpdateSiteAuthSettings", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteAuthSettings", - "in": "body", - "description": "Auth settings associated with web app", - "required": true, - "schema": { - "$ref": "#/definitions/SiteAuthSettings" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteAuthSettings" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the Authentication / Authorization settings associated with web app", - "operationId": "Sites_UpdateSiteAuthSettingsSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteAuthSettings", - "in": "body", - "description": "Auth settings associated with web app", - "required": true, - "schema": { - "$ref": "#/definitions/SiteAuthSettings" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteAuthSettings" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the web app publishing credentials", - "operationId": "Sites_ListSitePublishingCredentials", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/User" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the web app publishing credentials", - "operationId": "Sites_ListSitePublishingCredentialsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/User" - } - } - }, - "deprecated": false, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the web app meta data.", - "operationId": "Sites_ListSiteMetadata", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the web app meta data.", - "operationId": "Sites_ListSiteMetadataSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the meta data for web app", - "operationId": "Sites_UpdateSiteMetadata", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "metadata", - "in": "body", - "description": "Meta data of web app", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the meta data for web app", - "operationId": "Sites_UpdateSiteMetadataSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "metadata", - "in": "body", - "description": "Meta data of web app", - "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/StringDictionary" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the web app logs configuration", - "operationId": "Sites_GetSiteLogsConfig", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the meta data for web app", - "operationId": "Sites_UpdateSiteLogsConfig", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteLogsConfig", - "in": "body", - "description": "Site logs configuration", - "required": true, - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the web app logs configuration", - "operationId": "Sites_GetSiteLogsConfigSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the meta data for web app", - "operationId": "Sites_UpdateSiteLogsConfigSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "siteLogsConfig", - "in": "body", - "description": "Site logs configuration", - "required": true, - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": { - "get": { - "tags": [ - "Sites" - ], - "operationId": "Sites_ListSitePremierAddOnsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { - "get": { - "tags": [ - "Sites" - ], - "operationId": "Sites_ListSitePremierAddOns", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": { - "get": { - "tags": [ - "Sites" - ], - "operationId": "Sites_GetSitePremierAddOnSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "operationId": "Sites_AddSitePremierAddOnSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOn", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PremierAddOnRequest" - } - }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "operationId": "Sites_DeleteSitePremierAddOnSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { - "get": { - "tags": [ - "Sites" - ], - "operationId": "Sites_GetSitePremierAddOn", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "operationId": "Sites_AddSitePremierAddOn", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOn", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PremierAddOnRequest" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "operationId": "Sites_DeleteSitePremierAddOn", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the backup configuration for a web app", - "operationId": "Sites_GetSiteBackupConfiguration", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupRequest" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the backup configuration for a web app", - "operationId": "Sites_GetSiteBackupConfigurationSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupRequest" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates backup configuration of web app", - "operationId": "Sites_UpdateSiteBackupConfiguration", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on backup request", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupRequest" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates backup configuration of web app", - "operationId": "Sites_UpdateSiteBackupConfigurationSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on backup request", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupRequest" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Creates web app backup", - "operationId": "Sites_BackupSite", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on backup request", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Creates web app backup", - "operationId": "Sites_BackupSiteSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on backup request", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Discovers existing web app backups that can be restored", - "operationId": "Sites_DiscoverSiteRestore", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on restore request", - "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover": { - "put": { - "tags": [ - "Sites" - ], - "summary": "Discovers existing web app backups that can be restored", - "operationId": "Sites_DiscoverSiteRestoreSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on restore request", - "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Lists all available backups for web app", - "operationId": "Sites_ListSiteBackups", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItemCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Lists all available backups for web app", - "operationId": "Sites_ListSiteBackupsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItemCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets status of a web app backup that may be in progress.", - "operationId": "Sites_GetSiteBackupStatus", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Deletes a backup from Azure Storage", - "operationId": "Sites_DeleteBackup", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets status of a web app backup that may be in progress.", - "operationId": "Sites_GetSiteBackupStatusSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Deletes a backup from Azure Storage", - "operationId": "Sites_DeleteBackupSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", - "operationId": "Sites_GetSiteBackupStatusSecretsSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on backup request", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", - "operationId": "Sites_GetSiteBackupStatusSecrets", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on backup request", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupItem" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Restores a web app", - "operationId": "Sites_RestoreSite", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup to restore", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on restore request", - "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RestoreResponse" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Restores a web app", - "operationId": "Sites_RestoreSiteSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup to restore", - "required": true, - "type": "string" - }, - { - "name": "request", - "in": "body", - "description": "Information on restore request", - "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RestoreResponse" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the quota usage numbers for web app", - "operationId": "Sites_GetSiteUsages", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CsmUsageQuotaCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets the quota usage numbers for web app", - "operationId": "Sites_GetSiteUsagesSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CsmUsageQuotaCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets metrics for web app", - "operationId": "Sites_GetSiteMetrics", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "details", - "in": "query", - "description": "If true, metric details are included in response", - "type": "boolean" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResourceMetricCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets metrics for web app", - "operationId": "Sites_GetSiteMetricsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "details", - "in": "query", - "description": "If true, metric details are included in response", - "type": "boolean" - }, - { - "name": "$filter", - "in": "query", - "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ResourceMetricCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets metric definitions for web app", - "operationId": "Sites_GetSiteMetricDefinitionsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Gets metric definitions for web app", - "operationId": "Sites_GetSiteMetricDefinitions", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the publishing profile for web app", - "operationId": "Sites_ListSitePublishingProfileXml", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "options", - "in": "body", - "description": "Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format.", - "required": true, - "schema": { - "$ref": "#/definitions/CsmPublishingProfileOptions" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "file" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Gets the publishing profile for web app", - "operationId": "Sites_ListSitePublishingProfileXmlSlot", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "options", - "in": "body", - "description": "Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format.", - "required": true, - "schema": { - "$ref": "#/definitions/CsmPublishingProfileOptions" - } - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "file" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Restarts web app", - "operationId": "Sites_RestartSite", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "softRestart", - "in": "query", - "description": "Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app", - "type": "boolean" - }, - { - "name": "synchronous", - "in": "query", - "description": "If true then the API will block until the app has been restarted", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Restarts web app", - "operationId": "Sites_RestartSiteSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "name": "softRestart", - "in": "query", - "description": "Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app", - "type": "boolean" - }, - { - "name": "synchronous", - "in": "query", - "description": "If true then the API will block until the app has been restarted", - "type": "boolean" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Starts web app", - "operationId": "Sites_StartSite", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Starts web app", - "operationId": "Sites_StartSiteSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Stops web app", - "operationId": "Sites_StopSite", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Stops web app", - "operationId": "Sites_StopSiteSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": { - "post": { - "tags": [ - "Sites" - ], - "operationId": "Sites_SyncSiteRepository", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": { - "post": { - "tags": [ - "Sites" - ], - "operationId": "Sites_SyncSiteRepositorySlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Generates new random app publishing password", - "operationId": "Sites_GenerateNewSitePublishingPasswordSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { - "post": { - "tags": [ - "Sites" - ], - "summary": "Generates new random app publishing password", - "operationId": "Sites_GenerateNewSitePublishingPassword", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "Name of web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", - "operationId": "Sites_GetSiteRelayServiceConnection", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "The name by which the Hybrid Connection is identified", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", - "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnection", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "The name by which the Hybrid Connection is identified", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The details of the Hybrid Connection", - "required": true, - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", - "operationId": "Sites_DeleteSiteRelayServiceConnection", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "The name by which the Hybrid Connection is identified", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", - "operationId": "Sites_UpdateSiteRelayServiceConnection", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "The name by which the Hybrid Connection is identified", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The details of the Hybrid Connection", - "required": true, - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", - "operationId": "Sites_GetSiteRelayServiceConnectionSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "The name by which the Hybrid Connection is identified", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for the web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", - "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnectionSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "The name by which the Hybrid Connection is identified", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The details of the Hybrid Connection", - "required": true, - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for the web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "deprecated": false - }, - "delete": { - "tags": [ - "Sites" - ], - "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", - "operationId": "Sites_DeleteSiteRelayServiceConnectionSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "The name by which the Hybrid Connection is identified", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for the web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", - "operationId": "Sites_UpdateSiteRelayServiceConnectionSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "entityName", - "in": "path", - "description": "The name by which the Hybrid Connection is identified", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The details of the Hybrid Connection", - "required": true, - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for the web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", - "operationId": "Sites_ListSiteRelayServiceConnections", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", - "operationId": "Sites_ListSiteRelayServiceConnectionsSlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for the web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a Virtual Network connection gateway associated with this web app and virtual network.", - "operationId": "Sites_GetSiteVnetGateway", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", - "in": "path", - "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "404": { - "description": "Gateway does not exist. Only the \"primary\" gateway exists presently." - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the Virtual Network Gateway.", - "operationId": "Sites_CreateOrUpdateSiteVNETConnectionGateway", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", - "in": "path", - "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties to update this gateway with.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetGateway" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Updates the Virtual Network Gateway.", - "operationId": "Sites_UpdateSiteVNETConnectionGateway", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", - "in": "path", - "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties to update this gateway with.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetGateway" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { - "get": { - "tags": [ - "Sites" - ], - "summary": "Retrieves a Virtual Network connection gateway associated with this web app and virtual network.", - "operationId": "Sites_GetSiteVnetGatewaySlot", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", - "in": "path", - "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", - "required": true, - "type": "string" - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "404": { - "description": "Gateway does not exist. Only the \"primary\" gateway exists presently." - } - }, - "deprecated": false - }, - "put": { - "tags": [ - "Sites" - ], - "summary": "Updates the Virtual Network Gateway.", - "operationId": "Sites_CreateOrUpdateSiteVNETConnectionGatewaySlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", - "in": "path", - "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties to update this gateway with.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetGateway" - } - } - }, - "deprecated": false - }, - "patch": { - "tags": [ - "Sites" - ], - "summary": "Updates the Virtual Network Gateway.", - "operationId": "Sites_UpdateSiteVNETConnectionGatewaySlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "The resource group name", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "path", - "description": "The name of the web app", - "required": true, - "type": "string" - }, - { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", - "in": "path", - "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", - "required": true, - "type": "string" - }, - { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties to update this gateway with.", - "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } - }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VnetGateway" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains": { - "get": { - "tags": [ - "TopLevelDomains" - ], - "summary": "Lists all top level domains supported for registration", - "operationId": "TopLevelDomains_GetGetTopLevelDomains", - "consumes": [], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TopLevelDomainCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}": { - "get": { - "tags": [ - "TopLevelDomains" - ], - "summary": "Gets details of a top level domain", - "operationId": "TopLevelDomains_GetTopLevelDomain", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the top level domain", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TopLevelDomain" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements": { - "post": { - "tags": [ - "TopLevelDomains" - ], - "summary": "Lists legal agreements that user needs to accept before purchasing domain", - "operationId": "TopLevelDomains_ListTopLevelDomainAgreements", - "consumes": [ - "application/json", - "text/json", - "application/xml", - "text/xml", - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/json", - "text/json" - ], - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Name of the top level domain", - "required": true, - "type": "string" - }, - { - "name": "agreementOption", - "in": "body", - "description": "Domain agreement options", - "required": true, - "schema": { - "$ref": "#/definitions/TopLevelDomainAgreementOption" - } - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TldLegalAgreementCollection" - } - } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web.Admin/environments/{environmentName}/usage": { - "get": { - "tags": [ - "Usage" - ], - "summary": "Returns usage records for specified subscription and resource groups", - "operationId": "Usage_GetUsage", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" - }, - { - "name": "environmentName", - "in": "path", - "description": "Environment name", - "required": true, - "type": "string" - }, - { - "name": "lastId", - "in": "query", - "description": "Last marker that was returned from the batch", - "required": true, - "type": "string" - }, - { - "name": "batchSize", - "in": "query", - "description": "size of the batch to be returned.", - "required": true, - "type": "integer", - "format": "int32" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Object" - } - } - }, - "deprecated": false - } - } - }, - "definitions": { - "CertificateCollection": { - "description": "Collection of certificates", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/Certificate" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "Certificate": { - "description": "App certificate", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "friendlyName": { - "description": "Friendly name of the certificate", - "type": "string" - }, - "subjectName": { - "description": "Subject name of the certificate", - "type": "string" - }, - "hostNames": { - "description": "Host names the certificate applies to", - "type": "array", - "items": { - "type": "string" - } - }, - "pfxBlob": { - "description": "Pfx blob", - "type": "string" - }, - "siteName": { - "description": "App name", - "type": "string" - }, - "selfLink": { - "description": "Self link", - "type": "string" - }, - "issuer": { - "description": "Certificate issuer", - "type": "string" - }, - "issueDate": { - "format": "date-time", - "description": "Certificate issue Date", - "type": "string" - }, - "expirationDate": { - "format": "date-time", - "description": "Certificate expriration date", - "type": "string" - }, - "password": { - "description": "Certificate password", - "type": "string" - }, - "thumbprint": { - "description": "Certificate thumbprint", - "type": "string" - }, - "valid": { - "description": "Is the certificate valid?", - "type": "boolean" - }, - "cerBlob": { - "description": "Raw bytes of .cer file", - "type": "string" - }, - "publicKeyHash": { - "description": "Public key hash", - "type": "string" - }, - "hostingEnvironmentProfile": { - "$ref": "#/definitions/HostingEnvironmentProfile", - "description": "Specification for the hosting environment (App Service Environment) to use for the certificate" - } - }, - "x-ms-client-flatten": true - } - } - }, - "HostingEnvironmentProfile": { - "description": "Specification for a hostingEnvironment (App Service Environment) to use for this resource", - "type": "object", - "properties": { - "id": { - "description": "Resource id of the hostingEnvironment (App Service Environment)", - "type": "string" - }, - "name": { - "description": "Name of the hostingEnvironment (App Service Environment) (read only)", - "type": "string" - }, - "type": { - "description": "Resource type of the hostingEnvironment (App Service Environment) (read only)", - "type": "string" - } - } - }, - "ArmPlan": { - "description": "The plan object in an ARM, represents a marketplace plan", - "type": "object", - "properties": { - "name": { - "description": "The name", - "type": "string" - }, - "publisher": { - "description": "The publisher", - "type": "string" - }, - "product": { - "description": "The product", - "type": "string" - }, - "promotionCode": { - "description": "The promotion code", - "type": "string" - }, - "version": { - "description": "Version of product", - "type": "string" - } - } - }, - "SkuDescription": { - "description": "Describes a sku for a scalable resource", - "type": "object", - "properties": { - "name": { - "description": "Name of the resource sku", - "type": "string" - }, - "tier": { - "description": "Service Tier of the resource sku", - "type": "string" - }, - "size": { - "description": "Size specifier of the resource sku", - "type": "string" - }, - "family": { - "description": "Family code of the resource sku", - "type": "string" - }, - "capacity": { - "format": "int32", - "description": "Current number of instances assigned to the resource", - "type": "integer" - } - } - }, - "Object": { - "type": "object", - "properties": {} - }, - "Csr": { - "description": "Certificate signing request object", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Name used to locate CSR object", - "type": "string" - }, - "distinguishedName": { - "description": "Distinguished name of certificate to be created", - "type": "string" - }, - "csrString": { - "description": "Actual CSR string created", - "type": "string" - }, - "pfxBlob": { - "description": "PFX certifcate of created certificate", - "type": "string" - }, - "password": { - "description": "PFX password", - "type": "string" - }, - "publicKeyHash": { - "description": "Hash of the certificates public key", - "type": "string" - }, - "hostingEnvironment": { - "description": "Hosting environment", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "ClassicMobileServiceCollection": { - "description": "Collection of Classic Mobile Services", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/ClassicMobileService" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "ClassicMobileService": { - "description": "A mobile service", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Name of the mobile service", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "DomainCollection": { - "description": "Collection of domains", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/Domain" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "Domain": { - "description": "Represents a domain", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "contactAdmin": { - "$ref": "#/definitions/Contact", - "description": "Admin contact information" - }, - "contactBilling": { - "$ref": "#/definitions/Contact", - "description": "Billing contact information" - }, - "contactRegistrant": { - "$ref": "#/definitions/Contact", - "description": "Registrant contact information" - }, - "contactTech": { - "$ref": "#/definitions/Contact", - "description": "Technical contact information" - }, - "registrationStatus": { - "description": "Domain registration status", - "enum": [ - "Active", - "Awaiting", - "Cancelled", - "Confiscated", - "Disabled", - "Excluded", - "Expired", - "Failed", - "Held", - "Locked", - "Parked", - "Pending", - "Reserved", - "Reverted", - "Suspended", - "Transferred", - "Unknown", - "Unlocked", - "Unparked", - "Updated", - "JsonConverterFailed" - ], - "type": "string", - "x-ms-enum": { - "name": "DomainStatus", - "modelAsString": false - } - }, - "provisioningState": { - "description": "Domain provisioning state", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "InProgress", - "Deleting" - ], - "type": "string", - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "nameServers": { - "description": "Name servers", - "type": "array", - "items": { - "type": "string" - } - }, - "privacy": { - "description": "If true then domain privacy is enabled for this domain", - "type": "boolean" - }, - "createdTime": { - "format": "date-time", - "description": "Domain creation timestamp", - "type": "string" - }, - "expirationTime": { - "format": "date-time", - "description": "Domain expiration timestamp", - "type": "string" - }, - "lastRenewedTime": { - "format": "date-time", - "description": "Timestamp when the domain was renewed last time", - "type": "string" - }, - "autoRenew": { - "description": "If true then domain will renewed automatically", - "type": "boolean" - }, - "readyForDnsRecordManagement": { - "description": "If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to", - "type": "boolean" - }, - "managedHostNames": { - "description": "All hostnames derived from the domain and assigned to Azure resources", - "type": "array", - "items": { - "$ref": "#/definitions/HostName" - } - }, - "consent": { - "$ref": "#/definitions/DomainPurchaseConsent", - "description": "Legal agreement consent" - } - }, - "x-ms-client-flatten": true - } - } - }, - "Contact": { - "description": "Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be be made publicly available through the Whois directories as per ICANN requirements.", - "type": "object", - "properties": { - "addressMailing": { - "$ref": "#/definitions/Address", - "description": "Mailing address" - }, - "email": { - "description": "Email address", - "type": "string" - }, - "fax": { - "description": "Fax number", - "type": "string" - }, - "jobTitle": { - "description": "Job title", - "type": "string" - }, - "nameFirst": { - "description": "First name", - "type": "string" - }, - "nameLast": { - "description": "Last name", - "type": "string" - }, - "nameMiddle": { - "description": "Middle name", - "type": "string" - }, - "organization": { - "description": "Organization", - "type": "string" - }, - "phone": { - "description": "Phone number", - "type": "string" - } - } - }, - "HostName": { - "description": "Details of a hostname derived from a domain", - "type": "object", - "properties": { - "name": { - "description": "Name of the hostname", - "type": "string" - }, - "siteNames": { - "description": "List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager", - "type": "array", - "items": { - "type": "string" - } - }, - "azureResourceName": { - "description": "Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name", - "type": "string" - }, - "azureResourceType": { - "description": "Type of the Azure resource the hostname is assigned to", - "enum": [ - "Website", - "TrafficManager" - ], - "type": "string", - "x-ms-enum": { - "name": "AzureResourceType", - "modelAsString": false - } - }, - "customHostNameDnsRecordType": { - "description": "Type of the Dns record", - "enum": [ - "CName", - "A" - ], - "type": "string", - "x-ms-enum": { - "name": "CustomHostNameDnsRecordType", - "modelAsString": false - } - }, - "hostNameType": { - "description": "Type of the hostname", - "enum": [ - "Verified", - "Managed" - ], - "type": "string", - "x-ms-enum": { - "name": "HostNameType", - "modelAsString": false - } - } - } - }, - "DomainPurchaseConsent": { - "description": "Domain purchase consent object representing acceptance of applicable legal agreements", - "type": "object", - "properties": { - "agreementKeys": { - "description": "List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource", - "type": "array", - "items": { - "type": "string" - } - }, - "agreedBy": { - "description": "Client IP address", - "type": "string" - }, - "agreedAt": { - "format": "date-time", - "description": "Timestamp when the agreements were accepted", - "type": "string" - } - } - }, - "Address": { - "description": "Address information for domain registration", - "type": "object", - "properties": { - "address1": { - "description": "Address 1", - "type": "string" - }, - "address2": { - "description": "Address 2", - "type": "string" - }, - "city": { - "description": "City", - "type": "string" - }, - "country": { - "description": "Country", - "type": "string" - }, - "postalCode": { - "description": "Postal code", - "type": "string" - }, - "state": { - "description": "State", - "type": "string" - } - } - }, - "User": { - "description": "Represents user crendentials used for publishing activity", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Username (internal)", - "type": "string" - }, - "publishingUserName": { - "description": "Username used for publishing", - "type": "string" - }, - "publishingPassword": { - "description": "Password used for publishing", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "GeoRegionCollection": { - "description": "Collection of geo regions", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/GeoRegion" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "GeoRegion": { - "description": "Geographical region", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Region name", - "type": "string" - }, - "description": { - "description": "Region description", - "type": "string" - }, - "displayName": { - "description": "Display name for region", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "ServerFarmCollection": { - "description": "Collection of serverfarms", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/ServerFarmWithRichSku" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "ServerFarmWithRichSku": { - "description": "App Service Plan Model", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "required": [ - "status" - ], - "properties": { - "name": { - "description": "Name for the App Service Plan", - "type": "string" - }, - "workerTierName": { - "description": "Target worker tier assigned to the App Service Plan", - "type": "string" - }, - "status": { - "description": "App Service Plan Status", - "enum": [ - "Ready", - "Pending" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "StatusOptions", - "modelAsString": false - } - }, - "subscription": { - "description": "App Service Plan Subscription", - "type": "string", - "readOnly": true - }, - "adminSiteName": { - "description": "App Service Plan administration site", - "type": "string" - }, - "hostingEnvironmentProfile": { - "$ref": "#/definitions/HostingEnvironmentProfile", - "description": "Specification for the hosting environment (App Service Environment) to use for the App Service Plan" - }, - "maximumNumberOfWorkers": { - "format": "int32", - "description": "Maximum number of instances that can be assigned to this App Service Plan", - "type": "integer" - }, - "geoRegion": { - "description": "Geographical location for the App Service Plan", - "type": "string", - "readOnly": true - }, - "perSiteScaling": { - "description": "If True apps assigned to this App Service Plan can be scaled independently\r\n If False apps assigned to this App Service Plan will scale to all instances of the plan", - "type": "boolean" - }, - "numberOfSites": { - "format": "int32", - "description": "Number of web apps assigned to this App Service Plan", - "type": "integer", - "readOnly": true - }, - "resourceGroup": { - "description": "Resource group of the serverfarm", - "type": "string", - "readOnly": true - } - }, - "x-ms-client-flatten": true - }, - "sku": { - "$ref": "#/definitions/SkuDescription" - } - } - }, - "SiteCollection": { - "description": "Collection of sites", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/Site" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "Site": { - "description": "Represents a web app", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "required": [ - "usageState", - "availabilityState" - ], - "properties": { - "name": { - "description": "Name of web app", - "type": "string" - }, - "state": { - "description": "State of the web app", - "type": "string", - "readOnly": true - }, - "hostNames": { - "description": "Hostnames associated with web app", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "repositorySiteName": { - "description": "Name of repository site", - "type": "string", - "readOnly": true - }, - "usageState": { - "description": "State indicating whether web app has exceeded its quota usage", - "enum": [ - "Normal", - "Exceeded" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "UsageState", - "modelAsString": false - } - }, - "enabled": { - "description": "True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line).", - "type": "boolean" - }, - "enabledHostNames": { - "description": "Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled\r\n the app is not served on those hostnames", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "availabilityState": { - "description": "Management information availability state for the web app. Possible values are Normal or Limited. \r\n Normal means that the site is running correctly and that management information for the site is available. \r\n Limited means that only partial management information for the site is available and that detailed site information is unavailable.", - "enum": [ - "Normal", - "Limited", - "DisasterRecoveryMode" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SiteAvailabilityState", - "modelAsString": false - } - }, - "hostNameSslStates": { - "description": "Hostname SSL states are used to manage the SSL bindings for site's hostnames.", - "type": "array", - "items": { - "$ref": "#/definitions/HostNameSslState" - } - }, - "serverFarmId": { - "type": "string" - }, - "lastModifiedTimeUtc": { - "format": "date-time", - "description": "Last time web app was modified in UTC", - "type": "string", - "readOnly": true - }, - "siteConfig": { - "$ref": "#/definitions/SiteConfig", - "description": "Configuration of web app" - }, - "trafficManagerHostNames": { - "description": "Read-only list of Azure Traffic manager hostnames associated with web app", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "premiumAppDeployed": { - "description": "If set indicates whether web app is deployed as a premium app", - "type": "boolean", - "readOnly": true - }, - "scmSiteAlsoStopped": { - "description": "If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false.", - "type": "boolean" - }, - "targetSwapSlot": { - "description": "Read-only property that specifies which slot this app will swap into", - "type": "string", - "readOnly": true - }, - "hostingEnvironmentProfile": { - "$ref": "#/definitions/HostingEnvironmentProfile", - "description": "Specification for the hosting environment (App Service Environment) to use for the web app" - }, - "microService": { - "description": "", - "type": "string" - }, - "gatewaySiteName": { - "description": "Name of gateway app associated with web app", - "type": "string" - }, - "clientAffinityEnabled": { - "description": "Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app", - "type": "boolean" - }, - "clientCertEnabled": { - "description": "Specifies if the client certificate is enabled for the web app", - "type": "boolean" - }, - "hostNamesDisabled": { - "description": "Specifies if the public hostnames are disabled the web app.\r\n If set to true the app is only accessible via API Management process", - "type": "boolean" - }, - "outboundIpAddresses": { - "description": "List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.", - "type": "string", - "readOnly": true - }, - "containerSize": { - "format": "int32", - "description": "Size of a function container", - "type": "integer" - }, - "maxNumberOfWorkers": { - "format": "int32", - "description": "Maximum number of workers\r\n This only applies to function container", - "type": "integer" - }, - "cloningInfo": { - "$ref": "#/definitions/CloningInfo", - "description": "This is only valid for web app creation. If specified, web app is cloned from \r\n a source web app" - }, - "resourceGroup": { - "description": "Resource group web app belongs to", - "type": "string", - "readOnly": true - }, - "isDefaultContainer": { - "description": "Site is a default container", - "type": "boolean", - "readOnly": true - }, - "defaultHostName": { - "description": "Default hostname of the web app", - "type": "string", - "readOnly": true - } - }, - "x-ms-client-flatten": true - } - } - }, - "SiteProperties": { - "type": "object", - "properties": { - "metadata": { - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - } - }, - "properties": { - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - } - }, - "appSettings": { - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - } - } - } - }, - "HostNameSslState": { - "description": "Object that represents a SSL-enabled host name.", - "required": [ - "sslState" - ], - "type": "object", - "properties": { - "name": { - "description": "Host name", - "type": "string" - }, - "sslState": { - "description": "SSL type", - "enum": [ - "Disabled", - "SniEnabled", - "IpBasedEnabled" - ], - "type": "string", - "x-ms-enum": { - "name": "SslState", - "modelAsString": false - } - }, - "virtualIP": { - "description": "Virtual IP address assigned to the host name if IP based SSL is enabled", - "type": "string" - }, - "thumbprint": { - "description": "SSL cert thumbprint", - "type": "string" - }, - "toUpdate": { - "description": "Set this flag to update existing host name", - "type": "boolean" - } - } - }, - "SiteConfig": { - "description": "Configuration of Azure web site", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "numberOfWorkers": { - "format": "int32", - "description": "Number of workers", - "type": "integer" - }, - "defaultDocuments": { - "description": "Default documents", - "type": "array", - "items": { - "type": "string" - } - }, - "netFrameworkVersion": { - "description": "Net Framework Version", - "type": "string" - }, - "phpVersion": { - "description": "Version of PHP", - "type": "string" - }, - "pythonVersion": { - "description": "Version of Python", - "type": "string" - }, - "requestTracingEnabled": { - "description": "Enable request tracing", - "type": "boolean" - }, - "requestTracingExpirationTime": { - "format": "date-time", - "description": "Request tracing expiration time", - "type": "string" - }, - "remoteDebuggingEnabled": { - "description": "Remote Debugging Enabled", - "type": "boolean" - }, - "remoteDebuggingVersion": { - "description": "Remote Debugging Version", - "type": "string" - }, - "httpLoggingEnabled": { - "description": "HTTP logging Enabled", - "type": "boolean" - }, - "logsDirectorySizeLimit": { - "format": "int32", - "description": "HTTP Logs Directory size limit", - "type": "integer" - }, - "detailedErrorLoggingEnabled": { - "description": "Detailed error logging enabled", - "type": "boolean" - }, - "publishingUsername": { - "description": "Publishing user name", - "type": "string" - }, - "publishingPassword": { - "description": "Publishing password", - "type": "string" - }, - "appSettings": { - "description": "Application Settings", - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - } - }, - "metadata": { - "description": "Site Metadata", - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - } - }, - "connectionStrings": { - "description": "Connection strings", - "type": "array", - "items": { - "$ref": "#/definitions/ConnStringInfo" - } - }, - "handlerMappings": { - "description": "Handler mappings", - "type": "array", - "items": { - "$ref": "#/definitions/HandlerMapping" - } - }, - "documentRoot": { - "description": "Document root", - "type": "string" - }, - "scmType": { - "description": "SCM type", - "type": "string" - }, - "use32BitWorkerProcess": { - "description": "Use 32 bit worker process", - "type": "boolean" - }, - "webSocketsEnabled": { - "description": "Web socket enabled.", - "type": "boolean" - }, - "alwaysOn": { - "description": "Always On", - "type": "boolean" - }, - "javaVersion": { - "description": "Java version", - "type": "string" - }, - "javaContainer": { - "description": "Java container", - "type": "string" - }, - "javaContainerVersion": { - "description": "Java container version", - "type": "string" - }, - "managedPipelineMode": { - "description": "Managed pipeline mode", - "enum": [ - "Integrated", - "Classic" - ], - "type": "string", - "x-ms-enum": { - "name": "ManagedPipelineMode", - "modelAsString": false - } - }, - "virtualApplications": { - "description": "Virtual applications", - "type": "array", - "items": { - "$ref": "#/definitions/VirtualApplication" - } - }, - "loadBalancing": { - "description": "Site load balancing", - "enum": [ - "WeightedRoundRobin", - "LeastRequests", - "LeastResponseTime", - "WeightedTotalTraffic", - "RequestHash" - ], - "type": "string", - "x-ms-enum": { - "name": "SiteLoadBalancing", - "modelAsString": false - } - }, - "experiments": { - "$ref": "#/definitions/Experiments", - "description": "This is work around for polymophic types" - }, - "limits": { - "$ref": "#/definitions/SiteLimits", - "description": "Site limits" - }, - "autoHealEnabled": { - "description": "Auto heal enabled", - "type": "boolean" - }, - "autoHealRules": { - "$ref": "#/definitions/AutoHealRules", - "description": "Auto heal rules" - }, - "tracingOptions": { - "description": "Tracing options", - "type": "string" - }, - "vnetName": { - "description": "Vnet name", - "type": "string" - }, - "cors": { - "$ref": "#/definitions/CorsSettings", - "description": "Cross-Origin Resource Sharing (CORS) settings." - }, - "apiDefinition": { - "$ref": "#/definitions/ApiDefinitionInfo", - "description": "Information about the formal API definition for the web app." - }, - "autoSwapSlotName": { - "description": "Auto swap slot name", - "type": "string" - }, - "localMySqlEnabled": { - "description": "Local mysql enabled", - "type": "boolean" - }, - "ipSecurityRestrictions": { - "description": "Ip Security restrictions", - "type": "array", - "items": { - "$ref": "#/definitions/IpSecurityRestriction" - } - } - }, - "x-ms-client-flatten": true - } - } - }, - "CloningInfo": { - "description": "Represents information needed for cloning operation", - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation Id of cloning operation. This id ties multiple cloning operations\r\n together to use the same snapshot", - "type": "string" - }, - "overwrite": { - "description": "Overwrite destination web app", - "type": "boolean" - }, - "cloneCustomHostNames": { - "description": "If true, clone custom hostnames from source web app", - "type": "boolean" - }, - "cloneSourceControl": { - "description": "Clone source control from source web app", - "type": "boolean" - }, - "sourceWebAppId": { - "description": "ARM resource id of the source web app. Web app resource id is of the form \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots", - "type": "string" - }, - "hostingEnvironment": { - "description": "Hosting environment", - "type": "string" - }, - "appSettingsOverrides": { - "description": "Application settings overrides for cloned web app. If specified these settings will override the settings cloned \r\n from source web app. If not specified, application settings from source web app are retained.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "configureLoadBalancing": { - "description": "If specified configure load balancing for source and clone site", - "type": "boolean" - }, - "trafficManagerProfileId": { - "description": "ARM resource id of the traffic manager profile to use if it exists. Traffic manager resource id is of the form \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}", - "type": "string" - }, - "trafficManagerProfileName": { - "description": "Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist", - "type": "string" - } - } - }, - "NameValuePair": { - "description": "Name value pair", - "type": "object", - "properties": { - "name": { - "description": "Pair name", - "type": "string" - }, - "value": { - "description": "Pair value", - "type": "string" - } - } - }, - "ConnStringInfo": { - "description": "Represents database connection string information", - "required": [ - "type" - ], - "type": "object", - "properties": { - "name": { - "description": "Name of connection string", - "type": "string" - }, - "connectionString": { - "description": "Connection string value", - "type": "string" - }, - "type": { - "description": "Type of database", - "enum": [ - "MySql", - "SQLServer", - "SQLAzure", - "Custom" - ], - "type": "string", - "x-ms-enum": { - "name": "DatabaseServerType", - "modelAsString": false - } - } - } - }, - "HandlerMapping": { - "description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \r\n For example it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.", - "type": "object", - "properties": { - "extension": { - "description": "Requests with this extension will be handled using the specified FastCGI application.", - "type": "string" - }, - "scriptProcessor": { - "description": "The absolute path to the FastCGI application.", - "type": "string" - }, - "arguments": { - "description": "Command-line arguments to be passed to the script processor.", - "type": "string" - } - } - }, - "VirtualApplication": { - "type": "object", - "properties": { - "virtualPath": { - "type": "string" - }, - "physicalPath": { - "type": "string" - }, - "preloadEnabled": { - "type": "boolean" - }, - "virtualDirectories": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualDirectory" - } - } - } - }, - "RoutingRule": { - "description": "Routing rules for TiP", - "type": "object", - "properties": { - "name": { - "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.", - "type": "string" - } - } - }, - "Experiments": { - "description": "Class containing Routing in production experiments", - "type": "object", - "properties": { - "rampUpRules": { - "description": "List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects.", - "type": "array", - "items": { - "$ref": "#/definitions/RampUpRule" - } - } - } - }, - "SiteLimits": { - "description": "Represents metric limits set on a web app.", - "type": "object", - "properties": { - "maxPercentageCpu": { - "format": "double", - "description": "Maximum allowed CPU usage percentage", - "type": "number" - }, - "maxMemoryInMb": { - "format": "int64", - "description": "Maximum allowed memory usage in MB", - "type": "integer" - }, - "maxDiskSizeInMb": { - "format": "int64", - "description": "Maximum allowed disk size usage in MB", - "type": "integer" - } - } - }, - "AutoHealRules": { - "description": "AutoHealRules - describes the rules which can be defined for auto-heal", - "type": "object", - "properties": { - "triggers": { - "$ref": "#/definitions/AutoHealTriggers", - "description": "Triggers - Conditions that describe when to execute the auto-heal actions" - }, - "actions": { - "$ref": "#/definitions/AutoHealActions", - "description": "Actions - Actions to be executed when a rule is triggered" - } - } - }, - "SiteAuthSettings": { - "description": "Configuration settings for the Azure App Service Authentication / Authorization feature.", - "type": "object", - "properties": { - "enabled": { - "description": "Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app.", - "type": "boolean" - }, - "httpApiPrefixPath": { - "description": "Gets or sets the relative path prefix used by platform HTTP APIs.\r\n Changing this value is not recommended except for compatibility reasons.", - "type": "string" - }, - "unauthenticatedClientAction": { - "description": "Gets or sets the action to take when an unauthenticated client attempts to access the app.", - "enum": [ - "RedirectToLoginPage", - "AllowAnonymous" - ], - "type": "string", - "x-ms-enum": { - "name": "UnauthenticatedClientAction", - "modelAsString": false - } - }, - "tokenStoreEnabled": { - "description": "Gets or sets a value indicating whether to durably store platform-specific security tokens\r\n obtained during login flows. This capability is disabled by default.", - "type": "boolean" - }, - "allowedExternalRedirectUrls": { - "description": "Gets or sets a collection of external URLs that can be redirected to as part of logging in\r\n or logging out of the web app. Note that the query string part of the URL is ignored.\r\n This is an advanced setting typically only needed by Windows Store application backends.\r\n Note that URLs within the current domain are always implicitly allowed.", - "type": "array", - "items": { - "type": "string" - } - }, - "defaultProvider": { - "description": "Gets or sets the default authentication provider to use when multiple providers are configured.\r\n This setting is only needed if multiple providers are configured and the unauthenticated client\r\n action is set to \"RedirectToLoginPage\".", - "enum": [ - "AzureActiveDirectory", - "Facebook", - "Google", - "MicrosoftAccount", - "Twitter" - ], - "type": "string", - "x-ms-enum": { - "name": "BuiltInAuthenticationProvider", - "modelAsString": false - } - }, - "clientId": { - "description": "Gets or sets the Client ID of this relying party application, known as the client_id.\r\n This setting is required for enabling OpenID Connection authentication with Azure Active Directory or \r\n other 3rd party OpenID Connect providers.\r\n More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", - "type": "string" - }, - "clientSecret": { - "description": "Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\r\n This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\r\n Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\r\n More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", - "type": "string" - }, - "issuer": { - "description": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n This URI is a case-sensitive identifier for the token issuer.\r\n More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html", - "type": "string" - }, - "allowedAudiences": { - "description": "Gets or sets a list of allowed audience values to consider when validating JWTs issued by \r\n Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an\r\n allowed audience, regardless of this setting.", - "type": "array", - "items": { - "type": "string" - } - }, - "additionalLoginParams": { - "description": "Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when\r\n a user logs in. Each parameter must be in the form \"key=value\".", - "type": "array", - "items": { - "type": "string" - } - }, - "aadClientId": { - "type": "string" - }, - "openIdIssuer": { - "type": "string" - }, - "googleClientId": { - "description": "Gets or sets the OpenID Connect Client ID for the Google web application.\r\n This setting is required for enabling Google Sign-In.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/", - "type": "string" - }, - "googleClientSecret": { - "description": "Gets or sets the client secret associated with the Google web application.\r\n This setting is required for enabling Google Sign-In.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/", - "type": "string" - }, - "googleOAuthScopes": { - "description": "Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\r\n This setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/", - "type": "array", - "items": { - "type": "string" - } - }, - "facebookAppId": { - "description": "Gets or sets the App ID of the Facebook app used for login.\r\n This setting is required for enabling Facebook Login.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login", - "type": "string" - }, - "facebookAppSecret": { - "description": "Gets or sets the App Secret of the Facebook app used for Facebook Login.\r\n This setting is required for enabling Facebook Login.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login", - "type": "string" - }, - "facebookOAuthScopes": { - "description": "Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\r\n This setting is optional.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login", - "type": "array", - "items": { - "type": "string" - } - }, - "twitterConsumerKey": { - "description": "Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in.\r\n This setting is required for enabling Twitter Sign-In.\r\n Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in", - "type": "string" - }, - "twitterConsumerSecret": { - "description": "Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in.\r\n This setting is required for enabling Twitter Sign-In.\r\n Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in", - "type": "string" - }, - "microsoftAccountClientId": { - "description": "Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication.\r\n This setting is required for enabling Microsoft Account authentication.\r\n Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm", - "type": "string" - }, - "microsoftAccountClientSecret": { - "description": "Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication.\r\n This setting is required for enabling Microsoft Account authentication.\r\n Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm", - "type": "string" - }, - "microsoftAccountOAuthScopes": { - "description": "Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\r\n This setting is optional. If not specified, \"wl.basic\" is used as the default scope.\r\n Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "CorsSettings": { - "description": "Cross-Origin Resource Sharing (CORS) settings for the web app.", - "type": "object", - "properties": { - "allowedOrigins": { - "description": "Gets or sets the list of origins that should be allowed to make cross-origin\r\n calls (for example: http://example.com:12345). Use \"*\" to allow all.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ApiDefinitionInfo": { - "description": "Information about the formal API definition for the web app.", - "type": "object", - "properties": { - "url": { - "description": "The URL of the API definition.", - "type": "string" - } - } - }, - "IpSecurityRestriction": { - "description": "Represents an ip security restriction on a web app.", - "type": "object", - "properties": { - "ipAddress": { - "description": "IP address the security restriction is valid for", - "type": "string" - }, - "subnetMask": { - "description": "Subnet mask for the range of IP addresses the restriction is valid for", - "type": "string" - } - } - }, - "VirtualDirectory": { - "type": "object", - "properties": { - "virtualPath": { - "type": "string" - }, - "physicalPath": { - "type": "string" - } - } - }, - "RampUpRule": { - "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance", - "type": "object", - "properties": { - "actionHostName": { - "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net", - "type": "string" - }, - "reroutePercentage": { - "format": "double", - "description": "Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName}", - "type": "number" - }, - "changeStep": { - "format": "double", - "description": "[Optional] In auto ramp up scenario this is the step to to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches \r\n {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specificed in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}.\r\n Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}", - "type": "number" - }, - "changeIntervalInMinutes": { - "format": "int32", - "description": "[Optional] Specifies interval in mimuntes to reevaluate ReroutePercentage", - "type": "integer" - }, - "minReroutePercentage": { - "format": "double", - "description": "[Optional] Specifies lower boundary above which ReroutePercentage will stay.", - "type": "number" - }, - "maxReroutePercentage": { - "format": "double", - "description": "[Optional] Specifies upper boundary below which ReroutePercentage will stay.", - "type": "number" - }, - "changeDecisionCallbackUrl": { - "description": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n https://www.siteextensions.net/packages/TiPCallback/", - "type": "string" - }, - "name": { - "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.", - "type": "string" - } - } - }, - "AutoHealTriggers": { - "description": "AutoHealTriggers - describes the triggers for auto-heal.", - "type": "object", - "properties": { - "requests": { - "$ref": "#/definitions/RequestsBasedTrigger", - "description": "Requests - Defines a rule based on total requests" - }, - "privateBytesInKB": { - "format": "int32", - "description": "PrivateBytesInKB - Defines a rule based on private bytes", - "type": "integer" - }, - "statusCodes": { - "description": "StatusCodes - Defines a rule based on status codes", - "type": "array", - "items": { - "$ref": "#/definitions/StatusCodesBasedTrigger" - } - }, - "slowRequests": { - "$ref": "#/definitions/SlowRequestsBasedTrigger", - "description": "SlowRequests - Defines a rule based on request execution time" - } - } - }, - "AutoHealActions": { - "description": "AutoHealActions - Describes the actions which can be\r\n taken by the auto-heal module when a rule is triggered.", - "required": [ - "actionType" - ], - "type": "object", - "properties": { - "actionType": { - "description": "ActionType - predefined action to be taken", - "enum": [ - "Recycle", - "LogEvent", - "CustomAction" - ], - "type": "string", - "x-ms-enum": { - "name": "AutoHealActionType", - "modelAsString": false - } - }, - "customAction": { - "$ref": "#/definitions/AutoHealCustomAction", - "description": "CustomAction - custom action to be taken" - }, - "minProcessExecutionTime": { - "description": "MinProcessExecutionTime - minimum time the process must execute\r\n before taking the action", - "type": "string" - } - } - }, - "RequestsBasedTrigger": { - "description": "RequestsBasedTrigger", - "type": "object", - "properties": { - "count": { - "format": "int32", - "description": "Count", - "type": "integer" - }, - "timeInterval": { - "description": "TimeInterval", - "type": "string" - } - } - }, - "StatusCodesBasedTrigger": { - "description": "StatusCodeBasedTrigger", - "type": "object", - "properties": { - "status": { - "format": "int32", - "description": "HTTP status code", - "type": "integer" - }, - "subStatus": { - "format": "int32", - "description": "SubStatus", - "type": "integer" - }, - "win32Status": { - "format": "int32", - "description": "Win32 error code", - "type": "integer" - }, - "count": { - "format": "int32", - "description": "Count", - "type": "integer" - }, - "timeInterval": { - "description": "TimeInterval", - "type": "string" - } - } - }, - "SlowRequestsBasedTrigger": { - "description": "SlowRequestsBasedTrigger", - "type": "object", - "properties": { - "timeTaken": { - "description": "TimeTaken", - "type": "string" - }, - "count": { - "format": "int32", - "description": "Count", - "type": "integer" - }, - "timeInterval": { - "description": "TimeInterval", - "type": "string" - } - } - }, - "AutoHealCustomAction": { - "description": "AutoHealCustomAction - Describes the custom action to be executed\r\n when an auto heal rule is triggered.", - "type": "object", - "properties": { - "exe": { - "description": "Executable to be run", - "type": "string" - }, - "parameters": { - "description": "Parameters for the executable", - "type": "string" - } - } - }, - "HostingEnvironmentCollection": { - "description": "Collection of hosting environments (App Service Environments)", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/HostingEnvironment" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "HostingEnvironment": { - "description": "Description of an hostingEnvironment (App Service Environment)", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "required": [ - "status" - ], - "properties": { - "name": { - "description": "Name of the hostingEnvironment (App Service Environment)", - "type": "string" - }, - "location": { - "description": "Location of the hostingEnvironment (App Service Environment), e.g. \"West US\"", - "type": "string" - }, - "status": { - "description": "Current status of the hostingEnvironment (App Service Environment)", - "enum": [ - "Preparing", - "Ready", - "Scaling", - "Deleting" - ], - "type": "string", - "x-ms-enum": { - "name": "HostingEnvironmentStatus", - "modelAsString": false - } - }, - "vnetName": { - "description": "Name of the hostingEnvironment's (App Service Environment) virtual network", - "type": "string" - }, - "vnetResourceGroupName": { - "description": "Resource group of the hostingEnvironment's (App Service Environment) virtual network", - "type": "string" - }, - "vnetSubnetName": { - "description": "Subnet of the hostingEnvironment's (App Service Environment) virtual network", - "type": "string" - }, - "virtualNetwork": { - "$ref": "#/definitions/VirtualNetworkProfile", - "description": "Description of the hostingEnvironment's (App Service Environment) virtual network" - }, - "internalLoadBalancingMode": { - "description": "Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET", - "enum": [ - "None", - "Web", - "Publishing" - ], - "type": "string", - "x-ms-enum": { - "name": "InternalLoadBalancingMode", - "modelAsString": false - } - }, - "multiSize": { - "description": "Front-end VM size, e.g. \"Medium\", \"Large\"", - "type": "string" - }, - "multiRoleCount": { - "format": "int32", - "description": "Number of front-end instances", - "type": "integer" - }, - "workerPools": { - "description": "Description of worker pools with worker size ids, VM sizes, and number of workers in each pool", - "type": "array", - "items": { - "$ref": "#/definitions/WorkerPool" - } - }, - "ipsslAddressCount": { - "format": "int32", - "description": "Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment)", - "type": "integer" - }, - "databaseEdition": { - "description": "Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. \"Standard\"", - "type": "string" - }, - "databaseServiceObjective": { - "description": "Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. \"S0\"", - "type": "string" - }, - "upgradeDomains": { - "format": "int32", - "description": "Number of upgrade domains of this hostingEnvironment (App Service Environment)", - "type": "integer" - }, - "subscriptionId": { - "description": "Subscription of the hostingEnvironment (App Service Environment)", - "type": "string" - }, - "dnsSuffix": { - "description": "DNS suffix of the hostingEnvironment (App Service Environment)", - "type": "string" - }, - "lastAction": { - "description": "Last deployment action on this hostingEnvironment (App Service Environment)", - "type": "string" - }, - "lastActionResult": { - "description": "Result of the last deployment action on this hostingEnvironment (App Service Environment)", - "type": "string" - }, - "allowedMultiSizes": { - "description": "List of comma separated strings describing which VM sizes are allowed for front-ends", - "type": "string" - }, - "allowedWorkerSizes": { - "description": "List of comma separated strings describing which VM sizes are allowed for workers", - "type": "string" - }, - "maximumNumberOfMachines": { - "format": "int32", - "description": "Maximum number of VMs in this hostingEnvironment (App Service Environment)", - "type": "integer" - }, - "vipMappings": { - "description": "Description of IP SSL mapping for this hostingEnvironment (App Service Environment)", - "type": "array", - "items": { - "$ref": "#/definitions/VirtualIPMapping" - } - }, - "environmentCapacities": { - "description": "Current total, used, and available worker capacities", - "type": "array", - "items": { - "$ref": "#/definitions/StampCapacity" - } - }, - "networkAccessControlList": { - "description": "Access control list for controlling traffic to the hostingEnvironment (App Service Environment)", - "type": "array", - "items": { - "$ref": "#/definitions/NetworkAccessControlEntry" - } - }, - "environmentIsHealthy": { - "description": "True/false indicating whether the hostingEnvironment (App Service Environment) is healthy", - "type": "boolean" - }, - "environmentStatus": { - "description": "Detailed message about with results of the last check of the hostingEnvironment (App Service Environment)", - "type": "string" - }, - "resourceGroup": { - "description": "Resource group of the hostingEnvironment (App Service Environment)", - "type": "string" - }, - "apiManagementAccountId": { - "description": "Api Management Account associated with this Hosting Environment", - "type": "string" - }, - "suspended": { - "description": "True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\r\n (most likely because NSG blocked the incoming traffic)", - "type": "boolean" - }, - "clusterSettings": { - "description": "Custom settings for changing the behavior of the hosting environment", - "type": "array", - "items": { - "$ref": "#/definitions/NameValuePair" - } - } - }, - "x-ms-client-flatten": true - } - } - }, - "VirtualNetworkProfile": { - "description": "Specification for using a virtual network", - "type": "object", - "properties": { - "id": { - "description": "Resource id of the virtual network", - "type": "string" - }, - "name": { - "description": "Name of the virtual network (read-only)", - "type": "string" - }, - "type": { - "description": "Resource type of the virtual network (read-only)", - "type": "string" - }, - "subnet": { - "description": "Subnet within the virtual network", - "type": "string" - } - } - }, - "WorkerPool": { - "description": "Worker pool of a hostingEnvironment (App Service Environment)", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "workerSizeId": { - "format": "int32", - "description": "Worker size id for referencing this worker pool", - "type": "integer" - }, - "computeMode": { - "description": "Shared or dedicated web app hosting", - "enum": [ - "Shared", - "Dedicated" - ], - "type": "string", - "x-ms-enum": { - "name": "ComputeModeOptions", - "modelAsString": false - } - }, - "workerSize": { - "description": "VM size of the worker pool instances", - "type": "string" - }, - "workerCount": { - "format": "int32", - "description": "Number of instances in the worker pool", - "type": "integer" - }, - "instanceNames": { - "description": "Names of all instances in the worker pool (read only)", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-flatten": true - }, - "sku": { - "$ref": "#/definitions/SkuDescription" - } - } - }, - "VirtualIPMapping": { - "description": "Class that represents a VIP mapping", - "type": "object", - "properties": { - "virtualIP": { - "description": "Virtual IP address", - "type": "string" - }, - "internalHttpPort": { - "format": "int32", - "description": "Internal HTTP port", - "type": "integer" - }, - "internalHttpsPort": { - "format": "int32", - "description": "Internal HTTPS port", - "type": "integer" - }, - "inUse": { - "description": "Is VIP mapping in use", - "type": "boolean" - } - } - }, - "StampCapacity": { - "description": "Class containing stamp capacity information", - "type": "object", - "properties": { - "name": { - "description": "Name of the stamp", - "type": "string" - }, - "availableCapacity": { - "format": "int64", - "description": "Available capacity (# of machines, bytes of storage etc...)", - "type": "integer" - }, - "totalCapacity": { - "format": "int64", - "description": "Total capacity (# of machines, bytes of storage etc...)", - "type": "integer" - }, - "unit": { - "description": "Name of the unit", - "type": "string" - }, - "computeMode": { - "description": "Shared/Dedicated workers", - "enum": [ - "Shared", - "Dedicated" - ], - "type": "string", - "x-ms-enum": { - "name": "ComputeModeOptions", - "modelAsString": false - } - }, - "workerSize": { - "description": "Size of the machines", - "enum": [ - "Default", - "Small", - "Medium", - "Large" - ], - "type": "string", - "x-ms-enum": { - "name": "WorkerSizeOptions", - "modelAsString": false - } - }, - "workerSizeId": { - "format": "int32", - "description": "Size Id of machines: \r\n 0 - Small\r\n 1 - Medium\r\n 2 - Large", - "type": "integer" - }, - "excludeFromCapacityAllocation": { - "description": "If true it includes basic sites\r\n Basic sites are not used for capacity allocation.", - "type": "boolean" - }, - "isApplicableForAllComputeModes": { - "description": "Is capacity applicable for all sites?", - "type": "boolean" - }, - "siteMode": { - "description": "Shared or Dedicated", - "type": "string" - } - } - }, - "NetworkAccessControlEntry": { - "type": "object", - "properties": { - "action": { - "enum": [ - "Permit", - "Deny" - ], - "type": "string", - "x-ms-enum": { - "name": "AccessControlEntryAction", - "modelAsString": false - } - }, - "description": { - "type": "string" - }, - "order": { - "format": "int32", - "type": "integer" - }, - "remoteSubnet": { - "type": "string" - } - } - }, - "ManagedHostingEnvironmentCollection": { - "description": "Collection of managed hosting environments", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedHostingEnvironment" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "ManagedHostingEnvironment": { - "description": "Description of a managed hosting environment", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "required": [ - "status" - ], - "properties": { - "name": { - "description": "Name of the managed hosting environment", - "type": "string" - }, - "location": { - "description": "Location of the managed hosting environment e.g. \"West US\"", - "type": "string" - }, - "status": { - "description": "Current status of the managed hosting environment", - "enum": [ - "Preparing", - "Ready", - "Deleting" - ], - "type": "string", - "x-ms-enum": { - "name": "ManagedHostingEnvironmentStatus", - "modelAsString": false - } - }, - "virtualNetwork": { - "$ref": "#/definitions/VirtualNetworkProfile", - "description": "Description of the managed hosting environment's virtual network" - }, - "ipsslAddressCount": { - "format": "int32", - "description": "Number of ip ssl addresses reserved for the managed hosting environment", - "type": "integer" - }, - "dnsSuffix": { - "description": "DNS suffix of the managed hosting environment", - "type": "string" - }, - "subscriptionId": { - "description": "Subscription of the managed hosting environment (read only)", - "type": "string" - }, - "resourceGroup": { - "description": "Resource group of the managed hosting environment (read only)", - "type": "string" - }, - "environmentIsHealthy": { - "description": "True/false indicating whether the managed hosting environment is healthy", - "type": "boolean" - }, - "environmentStatus": { - "description": "Detailed message about with results of the last check of the managed hosting environment", - "type": "string" - }, - "suspended": { - "description": "True/false indicating whether the managed hosting environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\r\n (most likely because NSG blocked the incoming traffic)", - "type": "boolean" - }, - "apiManagementAccount": { - "description": "Resource id of the api management account associated with this managed hosting environment (read only)", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "ResourceNameAvailabilityRequest": { - "description": "Resource name availability request content", - "type": "object", - "properties": { - "name": { - "description": "Resource name to verify", - "type": "string" - }, - "type": { - "description": "Resource type used for verification", - "type": "string" - }, - "isFqdn": { - "description": "Is fully qualified domain name", - "type": "boolean" - } - } - }, - "ResourceNameAvailability": { - "description": "Describes if a resource name is available", - "type": "object", - "properties": { - "nameAvailable": { - "description": "True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.", - "type": "boolean" - }, - "reason": { - "description": "Required if nameAvailable is false. 'Invalid' indicates the name provided does not match Azure WebApp service’s naming requirements. 'AlreadyExists' indicates that the name is already in use and is therefore unavailable.", - "type": "string" - }, - "message": { - "type": "string" - } - } - }, - "DomainControlCenterSsoRequest": { - "description": "Single sign on request information for domain management", - "type": "object", - "properties": { - "url": { - "description": "Url where the single sign on request is to be made", - "type": "string" - }, - "postParameterKey": { - "description": "Post parameter key", - "type": "string" - }, - "postParameterValue": { - "description": "Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value.", - "type": "string" - } - } - }, - "DomainRegistrationInput": { - "description": "Domain registration input for validation Api", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Name of the domain", - "type": "string" - }, - "contactAdmin": { - "$ref": "#/definitions/Contact", - "description": "Admin contact information" - }, - "contactBilling": { - "$ref": "#/definitions/Contact", - "description": "Billing contact information" - }, - "contactRegistrant": { - "$ref": "#/definitions/Contact", - "description": "Registrant contact information" - }, - "contactTech": { - "$ref": "#/definitions/Contact", - "description": "Technical contact information" - }, - "registrationStatus": { - "description": "Domain registration status", - "enum": [ - "Active", - "Awaiting", - "Cancelled", - "Confiscated", - "Disabled", - "Excluded", - "Expired", - "Failed", - "Held", - "Locked", - "Parked", - "Pending", - "Reserved", - "Reverted", - "Suspended", - "Transferred", - "Unknown", - "Unlocked", - "Unparked", - "Updated", - "JsonConverterFailed" - ], - "type": "string", - "x-ms-enum": { - "name": "DomainStatus", - "modelAsString": false - } - }, - "provisioningState": { - "description": "Domain provisioning state", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "InProgress", - "Deleting" - ], - "type": "string", - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "nameServers": { - "description": "Name servers", - "type": "array", - "items": { - "type": "string" - } - }, - "privacy": { - "description": "If true then domain privacy is enabled for this domain", - "type": "boolean" - }, - "createdTime": { - "format": "date-time", - "description": "Domain creation timestamp", - "type": "string" - }, - "expirationTime": { - "format": "date-time", - "description": "Domain expiration timestamp", - "type": "string" - }, - "lastRenewedTime": { - "format": "date-time", - "description": "Timestamp when the domain was renewed last time", - "type": "string" - }, - "autoRenew": { - "description": "If true then domain will renewed automatically", - "type": "boolean" - }, - "readyForDnsRecordManagement": { - "description": "If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to", - "type": "boolean" - }, - "managedHostNames": { - "description": "All hostnames derived from the domain and assigned to Azure resources", - "type": "array", - "items": { - "$ref": "#/definitions/HostName" - } - }, - "consent": { - "$ref": "#/definitions/DomainPurchaseConsent", - "description": "Legal agreement consent" - } - }, - "x-ms-client-flatten": true - } - } - }, - "NameIdentifier": { - "description": "Identifies an object", - "type": "object", - "properties": { - "name": { - "description": "Name of the object", - "type": "string" - } - } - }, - "DomainAvailablilityCheckResult": { - "description": "Domain availablility check result", - "type": "object", - "properties": { - "name": { - "description": "Name of the domain", - "type": "string" - }, - "available": { - "description": "If true then domain can be purchased using CreateDomain Api", - "type": "boolean" - }, - "domainType": { - "description": "Domain type", - "enum": [ - "Regular", - "SoftDeleted" - ], - "type": "string", - "x-ms-enum": { - "name": "DomainType", - "modelAsString": false - } - } - } - }, - "DomainRecommendationSearchParameters": { - "description": "Domain recommendation search parameters", - "type": "object", - "properties": { - "keywords": { - "description": "Keywords to be used for generating domain recommendations", - "type": "string" - }, - "maxDomainRecommendations": { - "format": "int32", - "description": "Maximum number of recommendations", - "type": "integer" - } - } - }, - "NameIdentifierCollection": { - "description": "Collection of domain name identifiers", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/NameIdentifier" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "CsmMoveResourceEnvelope": { - "description": "Class containing a list of the resources that need to be moved and the resource group they should be moved to", - "type": "object", - "properties": { - "targetResourceGroup": { - "type": "string" - }, - "resources": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "HostingEnvironmentDiagnostics": { - "description": "Diagnostics for a hosting environment (App Service Environment)", - "type": "object", - "properties": { - "name": { - "description": "Name/identifier of the diagnostics", - "type": "string" - }, - "diagnosicsOutput": { - "description": "Diagnostics output", - "type": "string" - } - } - }, - "StampCapacityCollection": { - "description": "Collection of stamp capacities", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/StampCapacity" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "AddressResponse": { - "description": "Describes main public ip address and any extra vips", - "type": "object", - "properties": { - "serviceIpAddress": { - "description": "Main public vip", - "type": "string" - }, - "internalIpAddress": { - "description": "VNET internal ip address of the hostingEnvironment (App Service Environment) if it is in internal load-balancing mode", - "type": "string" - }, - "outboundIpAddresses": { - "description": "IP addresses appearing on outbound connections", - "type": "array", - "items": { - "type": "string" - } - }, - "vipMappings": { - "description": "Additional vips", - "type": "array", - "items": { - "$ref": "#/definitions/VirtualIPMapping" - } - } - } - }, - "ResourceMetricCollection": { - "description": "Collection of metric responses", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/ResourceMetric" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "ResourceMetric": { - "description": "Object representing a metric for any resource", - "type": "object", - "properties": { - "name": { - "$ref": "#/definitions/ResourceMetricName", - "description": "Name of metric" - }, - "unit": { - "description": "Metric unit", - "type": "string" - }, - "timeGrain": { - "description": "Metric granularity. E.g PT1H, PT5M, P1D", - "type": "string" - }, - "startTime": { - "format": "date-time", - "description": "Metric start time", - "type": "string" - }, - "endTime": { - "format": "date-time", - "description": "Metric end time", - "type": "string" - }, - "resourceId": { - "description": "Metric resource Id", - "type": "string" - }, - "metricValues": { - "description": "Metric values", - "type": "array", - "items": { - "$ref": "#/definitions/ResourceMetricValue" - } - }, - "properties": { - "description": "Properties", - "type": "array", - "items": { - "$ref": "#/definitions/KeyValuePair[String,String]" - } - } - } - }, - "ResourceMetricName": { - "description": "Name of a metric for any resource", - "type": "object", - "properties": { - "value": { - "description": "metric name value", - "type": "string" - }, - "localizedValue": { - "description": "Localized metric name value", - "type": "string" - } - } - }, - "ResourceMetricValue": { - "description": "Value of resource metric", - "type": "object", - "properties": { - "timeStamp": { - "description": "Value timestamp", - "type": "string" - }, - "average": { - "format": "float", - "description": "Value average", - "type": "number" - }, - "minimum": { - "format": "float", - "description": "Value minimum", - "type": "number" - }, - "maximum": { - "format": "float", - "description": "Value maximum", - "type": "number" - }, - "total": { - "format": "float", - "description": "Value total", - "type": "number" - }, - "count": { - "format": "float", - "description": "Value count", - "type": "number" - } - } - }, - "KeyValuePair[String,String]": { - "type": "object", - "properties": { - "key": { - "type": "string", - "readOnly": true - }, - "value": { - "type": "string", - "readOnly": true - } - } - }, - "MetricDefinition": { - "description": "Class repesenting metadata for the metrics", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Name of the metric", - "type": "string" - }, - "unit": { - "description": "Unit of the metric", - "type": "string" - }, - "primaryAggregationType": { - "description": "Primary aggregation type", - "type": "string" - }, - "metricAvailabilities": { - "description": "List of time grains supported for the metric together with retention period", - "type": "array", - "items": { - "$ref": "#/definitions/MetricAvailabilily" - } - }, - "displayName": { - "description": "Friendly name shown in the UI", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "MetricAvailabilily": { - "description": "Class repesenting metrics availability and retention", - "type": "object", - "properties": { - "timeGrain": { - "description": "Time grain", - "type": "string" - }, - "retention": { - "description": "Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain}", - "type": "string" - } - } - }, - "CsmUsageQuotaCollection": { - "description": "Collection of csm usage quotas", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/CsmUsageQuota" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "CsmUsageQuota": { - "description": "Usage of the quota resource", - "type": "object", - "properties": { - "unit": { - "description": "Units of measurement for the quota resourse", - "type": "string" - }, - "nextResetTime": { - "format": "date-time", - "description": "Next reset time for the resource counter", - "type": "string" - }, - "currentValue": { - "format": "int64", - "description": "The current value of the resource counter", - "type": "integer" - }, - "limit": { - "format": "int64", - "description": "The resource limit", - "type": "integer" - }, - "name": { - "$ref": "#/definitions/LocalizableString", - "description": "Quota name" - } - } - }, - "LocalizableString": { - "description": "LocalizableString object containing the name and a localized value.", - "type": "object", - "properties": { - "value": { - "description": "Non localized name", - "type": "string" - }, - "localizedValue": { - "description": "Localized name", - "type": "string" - } - } - }, - "MetricDefinitionCollection": { - "description": "Collection of metric defintions", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/MetricDefinition" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "UsageCollection": { - "description": "Collection of usages", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "Usage": { - "description": "Class that represents usage of the quota resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "displayName": { - "description": "Friendly name shown in the UI", - "type": "string" - }, - "name": { - "description": "Name of the quota", - "type": "string" - }, - "resourceName": { - "description": "Name of the quota resource", - "type": "string" - }, - "unit": { - "description": "Units of measurement for the quota resource", - "type": "string" - }, - "currentValue": { - "format": "int64", - "description": "The current value of the resource counter", - "type": "integer" - }, - "limit": { - "format": "int64", - "description": "The resource limit", - "type": "integer" - }, - "nextResetTime": { - "format": "date-time", - "description": "Next reset time for the resource counter", - "type": "string" - }, - "computeMode": { - "description": "ComputeMode used for this usage", - "enum": [ - "Shared", - "Dedicated" - ], - "type": "string", - "x-ms-enum": { - "name": "ComputeModeOptions", - "modelAsString": false - } - }, - "siteMode": { - "description": "SiteMode used for this usage", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "WorkerPoolCollection": { - "description": "Collection of worker pools", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/WorkerPool" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "SkuInfoCollection": { - "description": "Collection of SkuInfos", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/SkuInfo" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "SkuInfo": { - "description": "Sku discovery information", - "type": "object", - "properties": { - "resourceType": { - "description": "Resource type that this sku applies to", - "type": "string" - }, - "sku": { - "$ref": "#/definitions/SkuDescription", - "description": "Name and tier of the sku" - }, - "capacity": { - "$ref": "#/definitions/SkuCapacity", - "description": "Min, max, and default scale values of the sku" - } - } - }, - "SkuCapacity": { - "description": "Description of the App Service Plan scale options", - "type": "object", - "properties": { - "minimum": { - "format": "int32", - "description": "Minimum number of Workers for this App Service Plan SKU", - "type": "integer" - }, - "maximum": { - "format": "int32", - "description": "Maximum number of Workers for this App Service Plan SKU", - "type": "integer" - }, - "default": { - "format": "int32", - "description": "Default number of Workers for this App Service Plan SKU", - "type": "integer" - }, - "scaleType": { - "description": "Available scale configurations for an App Service Plan", - "type": "string" - } - } - }, - "SourceControlCollection": { - "description": "Collection of soure controls", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/SourceControl" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "SourceControl": { - "description": "Describes the Source Control OAuth Token", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Name or Source Control Type", - "type": "string" - }, - "token": { - "description": "OAuth Access Token", - "type": "string" - }, - "tokenSecret": { - "description": "OAuth Access Token Secret", - "type": "string" - }, - "refreshToken": { - "description": "OAuth Refresh Token", - "type": "string" - }, - "expirationTime": { - "format": "date-time", - "description": "OAuth Token Expiration", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "Recommendation": { - "description": "Represents a recommendation result generated by the recommendation engine", - "required": [ - "level", - "channels", - "category" - ], - "type": "object", - "properties": { - "creationTime": { - "format": "date-time", - "description": "Timestamp when this instance was created.", - "type": "string" - }, - "recommendationId": { - "description": "A GUID value that each recommendation object is associated with.", - "type": "string" - }, - "resourceId": { - "description": "Full ARM resource ID string that this recommendation object is associated with.", - "type": "string" - }, - "resourceScope": { - "description": "Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.", - "type": "string" - }, - "ruleName": { - "description": "Unique name of the rule", - "type": "string" - }, - "displayName": { - "description": "UI friendly name of the rule (may not be unique)", - "type": "string" - }, - "message": { - "description": "Localized text of recommendation, good for UI.", - "type": "string" - }, - "level": { - "description": "Level indicating how critical this recommendation can impact.", - "enum": [ - "Critical", - "Warning", - "Information", - "NonUrgentSuggestion" - ], - "type": "string", - "x-ms-enum": { - "name": "NotificationLevel", - "modelAsString": false - } - }, - "channels": { - "description": "List of channels that this recommendation can apply.", - "enum": [ - "Notification", - "Api", - "Email", - "All" - ], - "type": "string", - "x-ms-enum": { - "name": "Channels", - "modelAsString": false - } - }, - "category": { - "description": "The category that this recommendation belongs to.", - "enum": [ - "Uncategorized", - "Test", - "UpSell", - "CrossSell", - "LiveSite" - ], - "type": "string", - "x-ms-enum": { - "name": "Category", - "modelAsString": false - } - }, - "actionName": { - "description": "Name of action recommended by this object.", - "type": "string" - }, - "enabled": { - "format": "int32", - "description": "On/off flag indicating the rule is currently enabled or disabled.", - "type": "integer" - }, - "startTime": { - "format": "date-time", - "description": "The beginning time of a range that the recommendation refers to.", - "type": "string" - }, - "endTime": { - "format": "date-time", - "description": "The end time of a range that the recommendation refers to.", - "type": "string" - }, - "nextNotificationTime": { - "format": "date-time", - "description": "When to notify this recommendation next. Null means that this will never be notified anymore.", - "type": "string" - }, - "notificationExpirationTime": { - "format": "date-time", - "description": "Date and time when this notification expires.", - "type": "string" - }, - "notifiedTime": { - "format": "date-time", - "description": "Last timestamp this instance was actually notified. Null means that this recommendation hasn't been notified yet.", - "type": "string" - }, - "score": { - "format": "double", - "description": "A metric value measured by the rule.", - "type": "number" - } - } - }, - "RecommendationRule": { - "description": "Represents a recommendation rule that the recommendation engine can perform", - "required": [ - "level", - "channels", - "category" - ], - "type": "object", - "properties": { - "name": { - "description": "Unique name of the rule", - "type": "string" - }, - "displayName": { - "description": "UI friendly name of the rule", - "type": "string" - }, - "message": { - "description": "Localized name of the rule (Good for UI)", - "type": "string" - }, - "recommendationId": { - "description": "Recommendation ID of an associated recommendation object tied to the rule, if exists.\r\n If such an object doesn't exist, it is set to null.", - "type": "string" - }, - "description": { - "description": "Localized detailed description of the rule", - "type": "string" - }, - "actionName": { - "description": "Name of action that is recommended by this rule in string", - "type": "string" - }, - "enabled": { - "format": "int32", - "description": "On/off flag indicating the rule is currently enabled or disabled.", - "type": "integer" - }, - "level": { - "description": "Level of impact indicating how critical this rule is.", - "enum": [ - "Critical", - "Warning", - "Information", - "NonUrgentSuggestion" - ], - "type": "string", - "x-ms-enum": { - "name": "NotificationLevel", - "modelAsString": false - } - }, - "channels": { - "description": "List of available channels that this rule applies.", - "enum": [ - "Notification", - "Api", - "Email", - "All" - ], - "type": "string", - "x-ms-enum": { - "name": "Channels", - "modelAsString": false - } - }, - "category": { - "description": "The category that the rule belongs to.", - "enum": [ - "Uncategorized", - "Test", - "UpSell", - "CrossSell", - "LiveSite" - ], - "type": "string", - "x-ms-enum": { - "name": "Category", - "modelAsString": false - } - } - } - }, - "VnetInfo": { - "description": "VNETInfo contract. This contract is public and is a stripped down version of VNETInfoInternal", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "vnetResourceId": { - "description": "The vnet resource id", - "type": "string" - }, - "certThumbprint": { - "description": "The client certificate thumbprint", - "type": "string" - }, - "certBlob": { - "description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \r\n Point-To-Site VPN connection.", - "type": "string" - }, - "routes": { - "description": "The routes that this virtual network connection uses.", - "type": "array", - "items": { - "$ref": "#/definitions/VnetRoute" - } - }, - "resyncRequired": { - "description": "Flag to determine if a resync is required", - "type": "boolean" - } - }, - "x-ms-client-flatten": true - } - } - }, - "VnetRoute": { - "description": "VnetRoute contract used to pass routing information for a vnet.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "The name of this route. This is only returned by the server and does not need to be set by the client.", - "type": "string" - }, - "startAddress": { - "description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.", - "type": "string" - }, - "endAddress": { - "description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.", - "type": "string" - }, - "routeType": { - "description": "The type of route this is:\r\n DEFAULT - By default, every web app has routes to the local address ranges specified by RFC1918\r\n INHERITED - Routes inherited from the real Virtual Network routes\r\n STATIC - Static route set on the web app only\r\n \r\n These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them\r\n with new INHERITED routes.", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "VnetGateway": { - "description": "The VnetGateway contract. This is used to give the vnet gateway access to the VPN package.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "vnetName": { - "description": "The VNET name.", - "type": "string" - }, - "vpnPackageUri": { - "description": "The URI where the Vpn package can be downloaded", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "NetworkFeatures": { - "description": "This is an object used to store a full view of network features (presently VNET integration and Hybrid Connections)\r\n for a web app.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "virtualNetworkName": { - "description": "The Vnet Name", - "type": "string" - }, - "virtualNetworkConnection": { - "$ref": "#/definitions/VnetInfo", - "description": "The Vnet Summary view" - }, - "hybridConnections": { - "description": "The Hybrid Connections Summary view", - "type": "array", - "items": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } - } - }, - "x-ms-client-flatten": true - } - } - }, - "RelayServiceConnectionEntity": { - "description": "Class that represents a Biztalk Hybrid Connection", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "entityName": { - "type": "string" - }, - "entityConnectionString": { - "type": "string" - }, - "resourceType": { - "type": "string" - }, - "resourceConnectionString": { - "type": "string" - }, - "hostname": { - "type": "string" - }, - "port": { - "format": "int32", - "type": "integer" - }, - "biztalkUri": { - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "CsmSlotEntity": { - "description": "Class containing deployment slot parameters", - "type": "object", - "properties": { - "targetSlot": { - "description": "Set the destination deployment slot during swap operation", - "type": "string" - }, - "preserveVnet": { - "description": "Get or set the flag indicating it should preserve VNet to the slot during swap", - "type": "boolean" - } - } - }, - "SlotDifferenceCollection": { - "description": "Collection of Slot Differences", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/SlotDifference" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "SlotDifference": { - "description": "An object describing the difference in setting values between two web app slots", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "type": { - "description": "Indicates the type of the difference: Information, Warning or Error.", - "type": "string" - }, - "settingType": { - "description": "The type of the settings: General, AppSetting or ConnectionString", - "type": "string" - }, - "diffRule": { - "description": "Rule that describes how to process the difference in settings during web app slot swap.", - "type": "string" - }, - "settingName": { - "description": "Name of the setting", - "type": "string" - }, - "valueInCurrentSlot": { - "description": "Value of the setting in the current web app slot", - "type": "string" - }, - "valueInTargetSlot": { - "description": "Value of the setting in the target web app slot", - "type": "string" - }, - "description": { - "description": "Description of the difference", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "SlotConfigNamesResource": { - "description": "Slot Config names azure resource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "connectionStringNames": { - "description": "List of connection string names", - "type": "array", - "items": { - "type": "string" - } - }, - "appSettingNames": { - "description": "List of application settings names", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ms-client-flatten": true - } - } - }, - "SlotConfigNames": { - "description": "Class containing names for connection strings and application settings to be marked as sticky to the slot \r\n and not moved during swap operation\r\n This is valid for all deployment slots under the site", - "type": "object", - "properties": { - "connectionStringNames": { - "description": "List of connection string names", - "type": "array", - "items": { - "type": "string" - } - }, - "appSettingNames": { - "description": "List of application settings names", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "SiteCloneability": { - "description": "Represents whether or not a web app is cloneable", - "required": [ - "result" - ], - "type": "object", - "properties": { - "result": { - "description": "Name of web app", - "enum": [ - "Cloneable", - "PartiallyCloneable", - "NotCloneable" - ], - "type": "string", - "x-ms-enum": { - "name": "CloneAbilityResult", - "modelAsString": false - } - }, - "blockingFeatures": { - "description": "List of features enabled on web app that prevent cloning", - "type": "array", - "items": { - "$ref": "#/definitions/SiteCloneabilityCriterion" - } - }, - "unsupportedFeatures": { - "description": "List of features enabled on web app that are non-blocking but cannot be cloned. The web app can still be cloned\r\n but the features in this list will not be set up on cloned web app.", - "type": "array", - "items": { - "$ref": "#/definitions/SiteCloneabilityCriterion" - } - }, - "blockingCharacteristics": { - "description": "List of blocking application characteristics", - "type": "array", - "items": { - "$ref": "#/definitions/SiteCloneabilityCriterion" - } - } - } - }, - "SiteCloneabilityCriterion": { - "description": "Represents a site cloneability criterion", - "type": "object", - "properties": { - "name": { - "description": "Name of criterion", - "type": "string" - }, - "description": { - "description": "Description of criterion", - "type": "string" - } - } - }, - "CsmSiteRecoveryEntity": { - "description": "Class containting details about site recovery operation.", - "type": "object", - "properties": { - "snapshotTime": { - "format": "date-time", - "description": "Point in time in which the site recover should be attempted.", - "type": "string" - }, - "siteName": { - "description": "[Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead.", - "type": "string" - }, - "slotName": { - "description": "[Optional] Destination web app slot name into which web app should be recovered", - "type": "string" - } - } - }, - "DeletedSiteCollection": { - "description": "Collection of deleted sites", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/DeletedSite" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "DeletedSite": { - "description": "Reports deleted site including the timestamp of operation", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "required": [ - "usageState", - "availabilityState" - ], - "properties": { - "deletedTimestamp": { - "format": "date-time", - "description": "Time when the site was deleted", - "type": "string" - }, - "name": { - "description": "Name of web app", - "type": "string" - }, - "state": { - "description": "State of the web app", - "type": "string", - "readOnly": true - }, - "hostNames": { - "description": "Hostnames associated with web app", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "repositorySiteName": { - "description": "Name of repository site", - "type": "string", - "readOnly": true - }, - "usageState": { - "description": "State indicating whether web app has exceeded its quota usage", - "enum": [ - "Normal", - "Exceeded" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "UsageState", - "modelAsString": false - } - }, - "enabled": { - "description": "True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line).", - "type": "boolean" - }, - "enabledHostNames": { - "description": "Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled\r\n the app is not served on those hostnames", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "availabilityState": { - "description": "Management information availability state for the web app. Possible values are Normal or Limited. \r\n Normal means that the site is running correctly and that management information for the site is available. \r\n Limited means that only partial management information for the site is available and that detailed site information is unavailable.", - "enum": [ - "Normal", - "Limited", - "DisasterRecoveryMode" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "SiteAvailabilityState", - "modelAsString": false - } - }, - "hostNameSslStates": { - "description": "Hostname SSL states are used to manage the SSL bindings for site's hostnames.", - "type": "array", - "items": { - "$ref": "#/definitions/HostNameSslState" - } - }, - "serverFarmId": { - "type": "string" - }, - "lastModifiedTimeUtc": { - "format": "date-time", - "description": "Last time web app was modified in UTC", - "type": "string", - "readOnly": true - }, - "siteConfig": { - "$ref": "#/definitions/SiteConfig", - "description": "Configuration of web app" - }, - "trafficManagerHostNames": { - "description": "Read-only list of Azure Traffic manager hostnames associated with web app", - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, - "premiumAppDeployed": { - "description": "If set indicates whether web app is deployed as a premium app", - "type": "boolean", - "readOnly": true - }, - "scmSiteAlsoStopped": { - "description": "If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false.", - "type": "boolean" - }, - "targetSwapSlot": { - "description": "Read-only property that specifies which slot this app will swap into", - "type": "string", - "readOnly": true - }, - "hostingEnvironmentProfile": { - "$ref": "#/definitions/HostingEnvironmentProfile", - "description": "Specification for the hosting environment (App Service Environment) to use for the web app" - }, - "microService": { - "description": "", - "type": "string" - }, - "gatewaySiteName": { - "description": "Name of gateway app associated with web app", - "type": "string" - }, - "clientAffinityEnabled": { - "description": "Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app", - "type": "boolean" - }, - "clientCertEnabled": { - "description": "Specifies if the client certificate is enabled for the web app", - "type": "boolean" - }, - "hostNamesDisabled": { - "description": "Specifies if the public hostnames are disabled the web app.\r\n If set to true the app is only accessible via API Management process", - "type": "boolean" - }, - "outboundIpAddresses": { - "description": "List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.", - "type": "string", - "readOnly": true - }, - "containerSize": { - "format": "int32", - "description": "Size of a function container", - "type": "integer" - }, - "maxNumberOfWorkers": { - "format": "int32", - "description": "Maximum number of workers\r\n This only applies to function container", - "type": "integer" - }, - "cloningInfo": { - "$ref": "#/definitions/CloningInfo", - "description": "This is only valid for web app creation. If specified, web app is cloned from \r\n a source web app" - }, - "resourceGroup": { - "description": "Resource group web app belongs to", - "type": "string", - "readOnly": true - }, - "isDefaultContainer": { - "description": "Site is a default container", - "type": "boolean", - "readOnly": true - }, - "defaultHostName": { - "description": "Default hostname of the web app", - "type": "string", - "readOnly": true - } - }, - "x-ms-client-flatten": true - } - } - }, - "DeploymentCollection": { - "description": "Collection of app deployments", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/Deployment" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "Deployment": { - "description": "Represents user crendentials used for publishing activity", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "id": { - "description": "Id", - "type": "string" - }, - "status": { - "format": "int32", - "description": "Status", - "type": "integer" - }, - "message": { - "description": "Message", - "type": "string" - }, - "author": { - "description": "Author", - "type": "string" - }, - "deployer": { - "description": "Deployer", - "type": "string" - }, - "author_email": { - "description": "AuthorEmail", - "type": "string" - }, - "start_time": { - "format": "date-time", - "description": "StartTime", - "type": "string" - }, - "end_time": { - "format": "date-time", - "description": "EndTime", - "type": "string" - }, - "active": { - "description": "Active", - "type": "boolean" - }, - "details": { - "description": "Detail", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "SiteInstanceCollection": { - "description": "Collection of site instances", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/SiteInstance" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "SiteInstance": { - "description": "Instance of a web app", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Name of instance", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "HostNameBindingCollection": { - "description": "Collection of host name bindings", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/HostNameBinding" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "HostNameBinding": { - "description": "A host name binding object", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Hostname", - "type": "string" - }, - "siteName": { - "description": "Web app name", - "type": "string" - }, - "domainId": { - "description": "Fully qualified ARM domain resource URI", - "type": "string" - }, - "azureResourceName": { - "description": "Azure resource name", - "type": "string" - }, - "azureResourceType": { - "description": "Azure resource type", - "enum": [ - "Website", - "TrafficManager" - ], - "type": "string", - "x-ms-enum": { - "name": "AzureResourceType", - "modelAsString": false - } - }, - "customHostNameDnsRecordType": { - "description": "Custom DNS record type", - "enum": [ - "CName", - "A" - ], - "type": "string", - "x-ms-enum": { - "name": "CustomHostNameDnsRecordType", - "modelAsString": false - } - }, - "hostNameType": { - "description": "Host name type", - "enum": [ - "Verified", - "Managed" - ], - "type": "string", - "x-ms-enum": { - "name": "HostNameType", - "modelAsString": false - } - } - }, - "x-ms-client-flatten": true - } - } - }, - "SiteSourceControl": { - "description": "Describes the source control configuration for web app", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "repoUrl": { - "description": "Repository or source control url", - "type": "string" - }, - "branch": { - "description": "Name of branch to use for deployment", - "type": "string" - }, - "isManualIntegration": { - "description": "Whether to manual or continuous integration", - "type": "boolean" - }, - "deploymentRollbackEnabled": { - "description": "Whether to manual or continuous integration", - "type": "boolean" - }, - "isMercurial": { - "description": "Mercurial or Git repository type", - "type": "boolean" - } - }, - "x-ms-client-flatten": true - } - } - }, - "StringDictionary": { - "description": "String dictionary resource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Settings", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-client-flatten": true - } - } - }, - "ConnectionStringDictionary": { - "description": "String dictionary resource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "Connection strings", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConnStringValueTypePair" - }, - "x-ms-client-flatten": true - } - } - }, - "ConnStringValueTypePair": { - "description": "Database connection string value to type pair", - "required": [ - "type" - ], - "type": "object", - "properties": { - "value": { - "description": "Value of pair", - "type": "string" - }, - "type": { - "description": "Type of database", - "enum": [ - "MySql", - "SQLServer", - "SQLAzure", - "Custom" - ], - "type": "string", - "x-ms-enum": { - "name": "DatabaseServerType", - "modelAsString": false - } - } - } - }, - "SiteLogsConfig": { - "description": "Configuration of Azure web site", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "applicationLogs": { - "$ref": "#/definitions/ApplicationLogsConfig", - "description": "Application logs configuration" - }, - "httpLogs": { - "$ref": "#/definitions/HttpLogsConfig", - "description": "Http logs configuration" - }, - "failedRequestsTracing": { - "$ref": "#/definitions/EnabledConfig", - "description": "Failed requests tracing configuration" - }, - "detailedErrorMessages": { - "$ref": "#/definitions/EnabledConfig", - "description": "Detailed error messages configuration" - } - }, - "x-ms-client-flatten": true - } - } - }, - "ApplicationLogsConfig": { - "description": "Application logs configuration", - "type": "object", - "properties": { - "fileSystem": { - "$ref": "#/definitions/FileSystemApplicationLogsConfig", - "description": "Application logs to file system configuration" - }, - "azureTableStorage": { - "$ref": "#/definitions/AzureTableStorageApplicationLogsConfig", - "description": "Application logs to azure table storage configuration" - }, - "azureBlobStorage": { - "$ref": "#/definitions/AzureBlobStorageApplicationLogsConfig", - "description": "Application logs to blob storage configuration" - } - } - }, - "HttpLogsConfig": { - "description": "Http logs configuration", - "type": "object", - "properties": { - "fileSystem": { - "$ref": "#/definitions/FileSystemHttpLogsConfig", - "description": "Http logs to file system configuration" - }, - "azureBlobStorage": { - "$ref": "#/definitions/AzureBlobStorageHttpLogsConfig", - "description": "Http logs to azure blob storage configuration" - } - } - }, - "EnabledConfig": { - "description": "Enabled configuration", - "type": "object", - "properties": { - "enabled": { - "description": "Enabled", - "type": "boolean" - } - } - }, - "FileSystemApplicationLogsConfig": { - "description": "Application logs to file system configuration", - "type": "object", - "properties": { - "level": { - "description": "Log level", - "enum": [ - "Off", - "Verbose", - "Information", - "Warning", - "Error" - ], - "type": "string", - "x-ms-enum": { - "name": "LogLevel", - "modelAsString": false - } - } - } - }, - "AzureTableStorageApplicationLogsConfig": { - "description": "Application logs to azure table storage configuration", - "type": "object", - "properties": { - "level": { - "description": "Log level", - "enum": [ - "Off", - "Verbose", - "Information", - "Warning", - "Error" - ], - "type": "string", - "x-ms-enum": { - "name": "LogLevel", - "modelAsString": false - } - }, - "sasUrl": { - "description": "SAS url to an azure table with add/query/delete permissions", - "type": "string" - } - } - }, - "AzureBlobStorageApplicationLogsConfig": { - "description": "Application logs azure blob storage configuration", - "type": "object", - "properties": { - "level": { - "description": "Log level", - "enum": [ - "Off", - "Verbose", - "Information", - "Warning", - "Error" - ], - "type": "string", - "x-ms-enum": { - "name": "LogLevel", - "modelAsString": false - } - }, - "sasUrl": { - "description": "SAS url to a azure blob container with read/write/list/delete permissions", - "type": "string" - }, - "retentionInDays": { - "format": "int32", - "description": "Retention in days.\r\n Remove blobs older than X days.\r\n 0 or lower means no retention.", - "type": "integer" - } - } - }, - "FileSystemHttpLogsConfig": { - "description": "Http logs to file system configuration", - "type": "object", - "properties": { - "retentionInMb": { - "format": "int32", - "description": "Maximum size in megabytes that http log files can use.\r\n When reached old log files will be removed to make space for new ones.\r\n Value can range between 25 and 100.", - "type": "integer" - }, - "retentionInDays": { - "format": "int32", - "description": "Retention in days.\r\n Remove files older than X days.\r\n 0 or lower means no retention.", - "type": "integer" - }, - "enabled": { - "description": "Enabled", - "type": "boolean" - } - } - }, - "AzureBlobStorageHttpLogsConfig": { - "description": "Http logs to azure blob storage configuration", - "type": "object", - "properties": { - "sasUrl": { - "description": "SAS url to a azure blob container with read/write/list/delete permissions", - "type": "string" - }, - "retentionInDays": { - "format": "int32", - "description": "Retention in days.\r\n Remove blobs older than X days.\r\n 0 or lower means no retention.", - "type": "integer" - }, - "enabled": { - "description": "Enabled", - "type": "boolean" - } - } - }, - "PremierAddOnRequest": { - "type": "object", - "properties": { - "location": { - "description": "Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia", - "type": "string" - }, - "tags": { - "description": "Tags associated with resource", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "plan": { - "$ref": "#/definitions/ArmPlan", - "description": "Azure resource manager plan" - }, - "properties": { - "$ref": "#/definitions/Object", - "description": "Resource specific properties" - }, - "sku": { - "$ref": "#/definitions/SkuDescription", - "description": "Sku description of the resource" - } - } - }, - "BackupRequest": { - "description": "Description of a backup which will be performed", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "required": [ - "type" - ], - "properties": { - "name": { - "description": "Name of the backup", - "type": "string" - }, - "enabled": { - "description": "True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled", - "type": "boolean" - }, - "storageAccountUrl": { - "description": "SAS URL to the container", - "type": "string" - }, - "backupSchedule": { - "$ref": "#/definitions/BackupSchedule", - "description": "Schedule for the backup if it is executed periodically" - }, - "databases": { - "description": "Databases included in the backup", - "type": "array", - "items": { - "$ref": "#/definitions/DatabaseBackupSetting" - } - }, - "type": { - "description": "Type of the backup", - "enum": [ - "Default", - "Clone", - "Relocation" - ], - "type": "string", - "x-ms-enum": { - "name": "BackupRestoreOperationType", - "modelAsString": false - } - } - }, - "x-ms-client-flatten": true - } - } - }, - "BackupSchedule": { - "description": "Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.", - "required": [ - "frequencyUnit" - ], - "type": "object", - "properties": { - "frequencyInterval": { - "format": "int32", - "description": "How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)", - "type": "integer" - }, - "frequencyUnit": { - "description": "How often should be the backup executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)", - "enum": [ - "Day", - "Hour" - ], - "type": "string", - "x-ms-enum": { - "name": "FrequencyUnit", - "modelAsString": false - } - }, - "keepAtLeastOneBackup": { - "description": "True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.", - "type": "boolean" - }, - "retentionPeriodInDays": { - "format": "int32", - "description": "After how many days backups should be deleted", - "type": "integer" - }, - "startTime": { - "format": "date-time", - "description": "When the schedule should start working", - "type": "string" - }, - "lastExecutionTime": { - "format": "date-time", - "description": "The last time when this schedule was triggered", - "type": "string" - } - } - }, - "DatabaseBackupSetting": { - "description": "Note: properties are serialized in JSON format and stored in DB. \r\n if new properties are added they might not be in the previous data rows \r\n so please handle nulls", - "type": "object", - "properties": { - "databaseType": { - "description": "SqlAzure / MySql", - "type": "string" - }, - "name": { - "type": "string" - }, - "connectionStringName": { - "description": "Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\r\n This is used during restore with overwrite connection strings options.", - "type": "string" - }, - "connectionString": { - "description": "Contains a connection string to a database which is being backed up/restored. If the restore should happen to a new database, the database name inside is the new one.", - "type": "string" - } - } - }, - "BackupItem": { - "description": "Backup description", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "required": [ - "status" - ], - "properties": { - "id": { - "format": "int32", - "description": "Id of the backup.", - "type": "integer" - }, - "storageAccountUrl": { - "description": "SAS URL for the storage account container which contains this backup", - "type": "string" - }, - "blobName": { - "description": "Name of the blob which contains data for this backup", - "type": "string" - }, - "name": { - "description": "Name of this backup", - "type": "string" - }, - "status": { - "description": "Backup status", - "enum": [ - "InProgress", - "Failed", - "Succeeded", - "TimedOut", - "Created", - "Skipped", - "PartiallySucceeded", - "DeleteInProgress", - "DeleteFailed", - "Deleted" - ], - "type": "string", - "x-ms-enum": { - "name": "BackupItemStatus", - "modelAsString": false - } - }, - "sizeInBytes": { - "format": "int64", - "description": "Size of the backup in bytes", - "type": "integer" - }, - "created": { - "format": "date-time", - "description": "Timestamp of the backup creation", - "type": "string" - }, - "log": { - "description": "Details regarding this backup. Might contain an error message.", - "type": "string" - }, - "databases": { - "description": "List of databases included in the backup", - "type": "array", - "items": { - "$ref": "#/definitions/DatabaseBackupSetting" - } - }, - "scheduled": { - "description": "True if this backup has been created due to a schedule being triggered.", - "type": "boolean" - }, - "lastRestoreTimeStamp": { - "format": "date-time", - "description": "Timestamp of a last restore operation which used this backup.", - "type": "string" - }, - "finishedTimeStamp": { - "format": "date-time", - "description": "Timestamp when this backup finished.", - "type": "string" - }, - "correlationId": { - "description": "Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.", - "type": "string" - }, - "websiteSizeInBytes": { - "format": "int64", - "description": "Size of the original web app which has been backed up", - "type": "integer" - } - }, - "x-ms-client-flatten": true - } - } - }, - "RestoreRequest": { - "description": "Description of a restore request", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "required": [ - "operationType" - ], - "properties": { - "storageAccountUrl": { - "description": "SAS URL to the container", - "type": "string" - }, - "blobName": { - "description": "Name of a blob which contains the backup", - "type": "string" - }, - "overwrite": { - "description": "True if the restore operation can overwrite target site. \"True\" needed if trying to restore over an existing site.", - "type": "boolean" - }, - "siteName": { - "description": "Name of a site (Web App)", - "type": "string" - }, - "databases": { - "description": "Collection of databses which should be restored. This list has to match the list of databases included in the backup.", - "type": "array", - "items": { - "$ref": "#/definitions/DatabaseBackupSetting" - } - }, - "ignoreConflictingHostNames": { - "description": "Changes a logic when restoring a site with custom domains. If \"true\", custom domains are removed automatically. If \"false\", custom domains are added to \r\n the site object when it is being restored, but that might fail due to conflicts during the operation.", - "type": "boolean" - }, - "operationType": { - "description": "Operation type", - "enum": [ - "Default", - "Clone", - "Relocation" - ], - "type": "string", - "x-ms-enum": { - "name": "BackupRestoreOperationType", - "modelAsString": false - } - }, - "adjustConnectionStrings": { - "description": "Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site", - "type": "boolean" - }, - "hostingEnvironment": { - "description": "App Service Environment name, if needed (only when restoring a site to an App Service Environment)", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "BackupItemCollection": { - "description": "Collection of Backup Items", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/BackupItem" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "RestoreResponse": { - "description": "Response for a restore site request", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "operationId": { - "description": "When server starts the restore process, it will return an OperationId identifying that particular restore operation", - "type": "string" - } - }, - "x-ms-client-flatten": true - } - } - }, - "CsmPublishingProfileOptions": { - "description": "Publishing options for requested profile", - "type": "object", - "properties": { - "format": { - "description": "Name of the format. Valid values are: \r\n FileZilla3\r\n WebDeploy -- default\r\n Ftp", - "type": "string" - } - } - }, - "TopLevelDomainCollection": { - "description": "Collection of Top Level Domains", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/TopLevelDomain" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "TopLevelDomain": { - "description": "A top level domain object", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "name": { - "description": "Name of the top level domain", - "type": "string" - }, - "privacy": { - "description": "If true then the top level domain supports domain privacy", - "type": "boolean" - } - }, - "x-ms-client-flatten": true - } - } - }, - "TopLevelDomainAgreementOption": { - "description": "Options for retrieving the list of top level domain legal agreements", - "type": "object", - "properties": { - "includePrivacy": { - "description": "If true then the list of agreements will inclue agreements for domain privacy as well.", - "type": "boolean" - } - } - }, - "TldLegalAgreementCollection": { - "description": "Collection of Tld Legal Agreements", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/TldLegalAgreement" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "TldLegalAgreement": { - "description": "Represents a legal agreement for top level domain", - "type": "object", - "properties": { - "agreementKey": { - "description": "Unique identifier for the agreement", - "type": "string" - }, - "title": { - "description": "Agreement title", - "type": "string" - }, - "content": { - "description": "Agreement details", - "type": "string" - }, - "url": { - "description": "Url where a copy of the agreement details is hosted", - "type": "string" - } - } - }, - "Resource": { - "required": [ - "location" - ], - "properties": { - "id": { - "description": "Resource Id", - "type": "string" - }, - "name": { - "description": "Resource Name", - "type": "string" - }, - "location": { - "description": "Resource Location", - "type": "string" - }, - "type": { - "description": "Resource type", - "type": "string" - }, - "tags": { - "description": "Resource tags", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "x-ms-azure-resource": true - } - }, - "parameters": { - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription Id", - "required": true, - "type": "string" - }, - "apiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "API Version", - "required": true, - "type": "string" - } - } +{ + "swagger": "2.0", + "info": { + "version": "2015-08-01", + "title": "WebSite Management Client", + "description": "Use these APIs to manage Azure Websites resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see Authenticating Azure Resource Manager requests." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get certificates for a subscription in the specified resource group.", + "operationId": "Certificates_GetCertificates", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CertificateCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get a certificate by certificate name for a subscription in the specified resource group.", + "operationId": "Certificates_GetCertificate", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Certificate" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Certificates" + ], + "summary": "Creates or modifies an existing certificate.", + "operationId": "Certificates_CreateOrUpdateCertificate", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "description": "Details of certificate if it exists already.", + "required": true, + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Certificate" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Certificates" + ], + "summary": "Delete a certificate by name in a specificed subscription and resourcegroup.", + "operationId": "Certificates_DeleteCertificate", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate to be deleted.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Certificates" + ], + "summary": "Creates or modifies an existing certificate.", + "operationId": "Certificates_UpdateCertificate", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "description": "Details of certificate if it exists already.", + "required": true, + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Certificate" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Gets the certificate signing requests for a subscription in the specified resource group", + "operationId": "Certificates_GetCsrs", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Csr" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Gets a certificate signing request by certificate name for a subscription in the specified resource group", + "operationId": "Certificates_GetCsr", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Csr" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Certificates" + ], + "summary": "Creates or modifies an existing certificate signing request.", + "operationId": "Certificates_CreateOrUpdateCsr", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "name": "csrEnvelope", + "in": "body", + "description": "Details of certificate signing request if it exists already.", + "required": true, + "schema": { + "$ref": "#/definitions/Csr" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Csr" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Certificates" + ], + "summary": "Delete the certificate signing request.", + "operationId": "Certificates_DeleteCsr", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate signing request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Certificates" + ], + "summary": "Creates or modifies an existing certificate signing request.", + "operationId": "Certificates_UpdateCsr", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the certificate.", + "required": true, + "type": "string" + }, + { + "name": "csrEnvelope", + "in": "body", + "description": "Details of certificate signing request if it exists already.", + "required": true, + "schema": { + "$ref": "#/definitions/Csr" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Csr" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices": { + "get": { + "tags": [ + "ClassicMobileServices" + ], + "summary": "Get all mobile services in a resource group.", + "operationId": "ClassicMobileServices_GetClassicMobileServices", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClassicMobileServiceCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}": { + "get": { + "tags": [ + "ClassicMobileServices" + ], + "summary": "Get a mobile service.", + "operationId": "ClassicMobileServices_GetClassicMobileService", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of mobile service", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClassicMobileService" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "ClassicMobileServices" + ], + "summary": "Delete a mobile service.", + "operationId": "ClassicMobileServices_DeleteClassicMobileService", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of mobile service", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Lists domains under a resource group", + "operationId": "Domains_GetDomains", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Gets details of a domain", + "operationId": "Domains_GetDomain", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Domain" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Domains" + ], + "summary": "Creates a domain", + "operationId": "Domains_CreateOrUpdateDomain", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": ">Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain", + "required": true, + "type": "string" + }, + { + "name": "domain", + "in": "body", + "description": "Domain registration information", + "required": true, + "schema": { + "$ref": "#/definitions/Domain" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Domain purchase is in progress", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "200": { + "description": "Domain purchase was successful", + "schema": { + "$ref": "#/definitions/Domain" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Domains" + ], + "summary": "Deletes a domain", + "operationId": "Domains_DeleteDomain", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain", + "required": true, + "type": "string" + }, + { + "name": "forceHardDeleteDomain", + "in": "query", + "description": "If true then the domain will be deleted immediately instead of after 24 hours", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Domain does not exist in Azure database probably because it has already been deleted", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Domains" + ], + "summary": "Creates a domain", + "operationId": "Domains_UpdateDomain", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": ">Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain", + "required": true, + "type": "string" + }, + { + "name": "domain", + "in": "body", + "description": "Domain registration information", + "required": true, + "schema": { + "$ref": "#/definitions/Domain" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Domain purchase is in progress", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "200": { + "description": "Domain purchase was successful", + "schema": { + "$ref": "#/definitions/Domain" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Retrieves the latest status of a domain purchase operation", + "operationId": "Domains_GetDomainOperation", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Domain purchase operation Id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Domain purchase is in progress", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "200": { + "description": "Domain purchase was successful", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "500": { + "description": "Domain purchase request failed" + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials": { + "get": { + "tags": [ + "Global" + ], + "summary": "Gets publishing credentials for the subscription owner", + "operationId": "Global_GetSubscriptionPublishingCredentials", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/User" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Global" + ], + "summary": "Updates publishing credentials for the subscription owner", + "operationId": "Global_UpdateSubscriptionPublishingCredentials", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "requestMessage", + "in": "body", + "description": "requestMessage with new publishing credentials", + "required": true, + "schema": { + "$ref": "#/definitions/User" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/User" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions": { + "get": { + "tags": [ + "Global" + ], + "summary": "Gets list of available geo regions", + "operationId": "Global_GetSubscriptionGeoRegions", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GeoRegionCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates": { + "get": { + "tags": [ + "Global" + ], + "summary": "Get all certificates for a subscription", + "operationId": "Global_GetAllCertificates", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CertificateCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms": { + "get": { + "tags": [ + "Global" + ], + "summary": "Gets all App Service Plans for a subcription", + "operationId": "Global_GetAllServerFarms", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "detailed", + "in": "query", + "description": "False to return a subset of App Service Plan properties, true to return all of the properties.\r\n Retrieval of all properties may increase the API latency.", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": { + "get": { + "tags": [ + "Global" + ], + "summary": "Gets all Web Apps for a subscription", + "operationId": "Global_GetAllSites", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments": { + "get": { + "tags": [ + "Global" + ], + "summary": "Gets all hostingEnvironments (App Service Environment) for a subscription", + "operationId": "Global_GetAllHostingEnvironments", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostingEnvironmentCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/managedHostingEnvironments": { + "get": { + "tags": [ + "Global" + ], + "summary": "Gets all managed hosting environments for a subscription", + "operationId": "Global_GetAllManagedHostingEnvironments", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedHostingEnvironmentCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/classicMobileServices": { + "get": { + "tags": [ + "Global" + ], + "summary": "Gets all mobile services for a subscription", + "operationId": "Global_GetAllClassicMobileServices", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClassicMobileServiceCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers": { + "get": { + "tags": [ + "Global" + ], + "summary": "List premier add on offers", + "operationId": "Global_ListPremierAddOnOffers", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable/{name}": { + "get": { + "tags": [ + "Global" + ], + "summary": "Whether hosting environment name is available", + "operationId": "Global_IsHostingEnvironmentWithLegacyNameAvailable", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Hosting environment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable": { + "get": { + "tags": [ + "Global" + ], + "summary": "Whether hosting environment name is available", + "operationId": "Global_IsHostingEnvironmentNameAvailable", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Hosting environment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability": { + "post": { + "tags": [ + "Global" + ], + "summary": "Check if resource name is available", + "operationId": "Global_CheckNameAvailability", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "request", + "in": "body", + "description": "Name availability request", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceNameAvailability" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains": { + "get": { + "tags": [ + "GlobalDomainRegistration" + ], + "summary": "Lists all domains in a subscription", + "operationId": "GlobalDomainRegistration_GetAllDomains", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest": { + "post": { + "tags": [ + "GlobalDomainRegistration" + ], + "summary": "Generates a single sign on request for domain management portal", + "operationId": "GlobalDomainRegistration_GetDomainControlCenterSsoRequest", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainControlCenterSsoRequest" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/validateDomainRegistrationInformation": { + "post": { + "tags": [ + "GlobalDomainRegistration" + ], + "summary": "Validates domain registration information", + "operationId": "GlobalDomainRegistration_ValidateDomainPurchaseInformation", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "domainRegistrationInput", + "in": "body", + "description": "Domain registration information", + "required": true, + "schema": { + "$ref": "#/definitions/DomainRegistrationInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability": { + "post": { + "tags": [ + "GlobalDomainRegistration" + ], + "summary": "Checks if a domain is available for registration", + "operationId": "GlobalDomainRegistration_CheckDomainAvailability", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "identifier", + "in": "body", + "description": "Name of the domain", + "required": true, + "schema": { + "$ref": "#/definitions/NameIdentifier" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainAvailablilityCheckResult" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations": { + "post": { + "tags": [ + "GlobalDomainRegistration" + ], + "summary": "Lists domain recommendations based on keywords", + "operationId": "GlobalDomainRegistration_ListDomainRecommendations", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Domain recommendation search parameters", + "required": true, + "schema": { + "$ref": "#/definitions/DomainRecommendationSearchParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameIdentifierCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": { + "post": { + "tags": [ + "GlobalResourceGroups" + ], + "operationId": "GlobalResourceGroups_MoveResources", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "moveResourceEnvelope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CsmMoveResourceEnvelope" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get properties of hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostingEnvironment" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Create or update a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_CreateOrUpdateHostingEnvironment", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "hostingEnvironmentEnvelope", + "in": "body", + "description": "Properties of hostingEnvironment (App Service Environment)", + "required": true, + "schema": { + "$ref": "#/definitions/HostingEnvironment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostingEnvironment" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/HostingEnvironment" + } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Delete a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_DeleteHostingEnvironment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "forceDelete", + "in": "query", + "description": "Delete even if the hostingEnvironment (App Service Environment) contains resources", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get diagnostic information for hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentDiagnostics", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/HostingEnvironmentDiagnostics" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get diagnostic information for hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentDiagnosticsItem", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "diagnosticsName", + "in": "path", + "description": "Name of the diagnostics", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostingEnvironmentDiagnostics" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get used, available, and total worker capacity for hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentCapacities", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StampCapacityCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get IP addresses assigned to the hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentVips", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AddressResponse" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get all hostingEnvironments (App Service Environments) in a resource group.", + "operationId": "HostingEnvironments_GetHostingEnvironments", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostingEnvironmentCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": { + "post": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Reboots all machines in a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_RebootHostingEnvironment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Asynchronous operation in progress", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "List all currently running operations on the hostingEnvironment (App Service Environment)", + "operationId": "HostingEnvironments_GetHostingEnvironmentOperations", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get status of an operation on a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentOperation", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "operation identifier GUID", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "202": { + "description": "Asynchronous operation in progress", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "404": { + "description": "Not found" + }, + "500": { + "description": "Operation failed" + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get global metrics of hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMetrics", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "Include instance details", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get global metric definitions of hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMetricDefinitions", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetricDefinition" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get global usages of hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentUsages", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmUsageQuotaCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get metrics for a multiRole pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "Beginning time of metrics query", + "type": "string" + }, + { + "name": "endTime", + "in": "query", + "description": "End time of metrics query", + "type": "string" + }, + { + "name": "timeGrain", + "in": "query", + "description": "Time granularity of metrics query", + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "Include instance details", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get metrics for a worker pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerMetrics", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "Include instance details", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get metric definitions for a multiRole pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleMetricDefinitions", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get metric definitions for a worker pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get usages for a multiRole pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleUsages", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get usages for a worker pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerUsages", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get all sites on the hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentSites", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "propertiesToInclude", + "in": "query", + "description": "Comma separated list of site properties to include", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentWebHostingPlans", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentServerFarms", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get all multi role pools", + "operationId": "HostingEnvironments_GetMultiRolePools", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPoolCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get properties of a multiRool pool.", + "operationId": "HostingEnvironments_GetMultiRolePool", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPool" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Create or update a multiRole pool.", + "operationId": "HostingEnvironments_CreateOrUpdateMultiRolePool", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "multiRolePoolEnvelope", + "in": "body", + "description": "Properties of multiRole pool", + "required": true, + "schema": { + "$ref": "#/definitions/WorkerPool" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPool" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/WorkerPool" + } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get available skus for scaling a multiRole pool.", + "operationId": "HostingEnvironments_GetMultiRolePoolSkus", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuInfoCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get all worker pools", + "operationId": "HostingEnvironments_GetWorkerPools", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPoolCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get properties of a worker pool.", + "operationId": "HostingEnvironments_GetWorkerPool", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPool" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Create or update a worker pool.", + "operationId": "HostingEnvironments_CreateOrUpdateWorkerPool", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "name": "workerPoolEnvelope", + "in": "body", + "description": "Properties of worker pool", + "required": true, + "schema": { + "$ref": "#/definitions/WorkerPool" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkerPool" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/WorkerPool" + } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get available skus for scaling a worker pool.", + "operationId": "HostingEnvironments_GetWorkerPoolSkus", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuInfoCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get metrics for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetWorkerPoolInstanceMetrics", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "name": "instance", + "in": "path", + "description": "Name of instance in the worker pool", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "Include instance details", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get metric definitions for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetWorkerPoolInstanceMetricDefinitions", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "name": "instance", + "in": "path", + "description": "Name of instance in the worker pool", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get metrics for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetMultiRolePoolInstanceMetrics", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "instance", + "in": "path", + "description": "Name of instance in the multiRole pool", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "Include instance details", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions": { + "get": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Get metric definitions for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetMultiRolePoolInstanceMetricDefinitions", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "name": "instance", + "in": "path", + "description": "Name of instance in the multiRole pool>", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend": { + "post": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Suspends the hostingEnvironment.", + "operationId": "HostingEnvironments_SuspendHostingEnvironment", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume": { + "post": { + "tags": [ + "HostingEnvironments" + ], + "summary": "Resumes the hostingEnvironment.", + "operationId": "HostingEnvironments_ResumeHostingEnvironment", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}": { + "get": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Get properties of a managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of managed hosting environment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedHostingEnvironment" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Create or update a managed hosting environment.", + "operationId": "ManagedHostingEnvironments_CreateOrUpdateManagedHostingEnvironment", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of managed hosting environment", + "required": true, + "type": "string" + }, + { + "name": "ManagedHostingEnvironmentEnvelope", + "in": "body", + "description": "Properties of managed hosting environment", + "required": true, + "schema": { + "$ref": "#/definitions/HostingEnvironment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Asynchronous operation in progress", + "schema": { + "$ref": "#/definitions/HostingEnvironment" + } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Delete a managed hosting environment.", + "operationId": "ManagedHostingEnvironments_DeleteManagedHostingEnvironment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of managed hosting environment", + "required": true, + "type": "string" + }, + { + "name": "forceDelete", + "in": "query", + "description": "Delete even if the managed hosting environment contains resources", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Asynchronous operation in progress", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments": { + "get": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Get all managed hosting environments in a resource group.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironments", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostingEnvironmentCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/capacities/virtualip": { + "get": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Get list of ip addresses assigned to a managed hosting environment", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentVips", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of managed hosting environment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AddressResponse" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/operations/{operationId}": { + "get": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Get status of an operation on a managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentOperation", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of managed hosting environment", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "operation identifier GUID", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation completed successfully", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "202": { + "description": "Asynchronous operation in progress", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "404": { + "description": "Not found" + }, + "500": { + "description": "Operation failed" + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites": { + "get": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Get all sites on the managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentSites", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of managed hosting environment", + "required": true, + "type": "string" + }, + { + "name": "propertiesToInclude", + "in": "query", + "description": "Comma separated list of site properties to include", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/webhostingplans": { + "get": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Get all serverfarms (App Service Plans) on the managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentWebHostingPlans", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of managed hosting environment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/serverfarms": { + "get": { + "tags": [ + "ManagedHostingEnvironments" + ], + "summary": "Get all serverfarms (App Service Plans) on the managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentServerFarms", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of managed hosting environment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmCollection" + } + } + }, + "deprecated": false + } + }, + "/providers/Microsoft.Web/sourcecontrols": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Gets the source controls available for Azure websites", + "operationId": "Provider_GetSourceControls", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlCollection" + } + } + }, + "deprecated": false + } + }, + "/providers/Microsoft.Web/sourcecontrols/{sourceControlType}": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Gets source control token", + "operationId": "Provider_GetSourceControl", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "sourceControlType", + "in": "path", + "description": "Type of source control", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Provider" + ], + "summary": "Updates source control token", + "operationId": "Provider_UpdateSourceControl", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "sourceControlType", + "in": "path", + "description": "Type of source control", + "required": true, + "type": "string" + }, + { + "name": "requestMessage", + "in": "body", + "description": "Source control token information", + "required": true, + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + } + }, + "deprecated": false + } + }, + "/providers/Microsoft.Web/publishingUsers/web": { + "get": { + "tags": [ + "Provider" + ], + "summary": "Gets publishing user", + "operationId": "Provider_GetPublishingUser", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/User" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Provider" + ], + "summary": "Updates publishing user", + "operationId": "Provider_UpdatePublishingUser", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "requestMessage", + "in": "body", + "description": "Details of publishing user", + "required": true, + "schema": { + "$ref": "#/definitions/User" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/User" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Gets a list of recommendations associated with the specified subscription.", + "operationId": "Recommendations_GetRecommendationBySubscription", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "featured", + "in": "query", + "description": "If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channels eq 'Api' or channel eq 'Notification'", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Recommendation" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Gets the detailed properties of the recommendation object for the specified web site.", + "operationId": "Recommendations_GetRuleDetailsBySiteName", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Recommendation rule name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationRule" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Gets a list of recommendations associated with the specified web site.", + "operationId": "Recommendations_GetRecommendedRulesForSite", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string" + }, + { + "name": "featured", + "in": "query", + "description": "If set, this API returns only the most critical recommendation among the others. Otherwise this API returns all recommendations available", + "type": "boolean" + }, + { + "name": "siteSku", + "in": "query", + "description": "The name of site SKU.", + "type": "string" + }, + { + "name": "numSlots", + "in": "query", + "description": "The number of site slots associated to the site", + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Recommendation" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory": { + "get": { + "tags": [ + "Recommendations" + ], + "summary": "Gets the list of past recommendations optionally specified by the time range.", + "operationId": "Recommendations_GetRecommendationHistoryForSite", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "siteName", + "in": "path", + "description": "Site name", + "required": true, + "type": "string" + }, + { + "name": "startTime", + "in": "query", + "description": "The start time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z'", + "type": "string" + }, + { + "name": "endTime", + "in": "query", + "description": "The end time of a time range to query, e.g. $filter=startTime eq '2015-01-01T00:00:00Z' and endTime eq '2015-01-02T00:00:00Z'", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Recommendation" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets collection of App Service Plans in a resource group for a given subscription.", + "operationId": "ServerFarms_GetServerFarms", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets specified App Service Plan in a resource group", + "operationId": "ServerFarms_GetServerFarm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmWithRichSku" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "ServerFarms" + ], + "summary": "Creates or updates an App Service Plan", + "operationId": "ServerFarms_CreateOrUpdateServerFarm", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "serverFarmEnvelope", + "in": "body", + "description": "Details of App Service Plan", + "required": true, + "schema": { + "$ref": "#/definitions/ServerFarmWithRichSku" + } + }, + { + "name": "allowPendingState", + "in": "query", + "description": "OBSOLETE: If true, allow pending state for App Service Plan", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmWithRichSku" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/ServerFarmWithRichSku" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ServerFarms" + ], + "summary": "Deletes a App Service Plan", + "operationId": "ServerFarms_DeleteServerFarm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Queries for App Serice Plan metrics", + "operationId": "ServerFarms_GetServerFarmMetrics", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "If true, metrics are broken down per App Service Plan instance", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "List of metrics that can be queried for an App Service Plan", + "operationId": "ServerFarms_GetServerFarmMetricDefintions", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets list of vnets associated with App Service Plan", + "operationId": "ServerFarms_GetVnetsForServerFarm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VnetInfo" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets a vnet associated with an App Service Plan", + "operationId": "ServerFarms_GetVnetFromServerFarm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + "404": { + "description": "Virtual network could not be found" + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets a list of all routes associated with a vnet, in an app service plan", + "operationId": "ServerFarms_GetRoutesForVnet", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VnetRoute" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets a specific route associated with a vnet, in an app service plan", + "operationId": "ServerFarms_GetRouteForVnet", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the virtual network route", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VnetRoute" + } + } + }, + "404": { + "description": "Specified route does not exist" + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "ServerFarms" + ], + "summary": "Creates a new route or updates an existing route for a vnet in an app service plan.", + "operationId": "ServerFarms_CreateOrUpdateVnetRoute", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the virtual network route", + "required": true, + "type": "string" + }, + { + "name": "route", + "in": "body", + "description": "The route object", + "required": true, + "schema": { + "$ref": "#/definitions/VnetRoute" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetRoute" + } + }, + "400": { + "description": "Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid" + }, + "404": { + "description": "Route not found. This will only occur when using the PATCH verb." + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "ServerFarms" + ], + "summary": "Deletes an existing route for a vnet in an app service plan.", + "operationId": "ServerFarms_DeleteVnetRoute", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the virtual network route", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "404": { + "description": "Specified route does not exist." + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "ServerFarms" + ], + "summary": "Creates a new route or updates an existing route for a vnet in an app service plan.", + "operationId": "ServerFarms_UpdateVnetRoute", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the virtual network route", + "required": true, + "type": "string" + }, + { + "name": "route", + "in": "body", + "description": "The route object", + "required": true, + "schema": { + "$ref": "#/definitions/VnetRoute" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetRoute" + } + }, + "400": { + "description": "Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid" + }, + "404": { + "description": "Route not found. This will only occur when using the PATCH verb." + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets the vnet gateway.", + "operationId": "ServerFarms_GetServerFarmVnetGateway", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of the virtual network", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "Name of the gateway. Only the 'primary' gateway is supported.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "ServerFarms" + ], + "summary": "Updates the vnet gateway", + "operationId": "ServerFarms_UpdateServerFarmVnetGateway", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the virtual network", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the gateway. Only 'primary' is supported.", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The gateway entity.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets list of Apps associated with an App Service Plan", + "operationId": "ServerFarms_GetServerFarmSites", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Skip to of web apps in a list. If specified, the resulting list will contain web apps starting from (including) the skipToken. Else, the resulting list contains web apps from the start of the list", + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Supported filter: $filter=state eq running. Returns only web apps that are currently running", + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "List page size. If specified, results are paged.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot": { + "post": { + "tags": [ + "ServerFarms" + ], + "summary": "Submit a reboot request for a worker machine in the specified server farm", + "operationId": "ServerFarms_RebootWorkerForServerFarm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of server farm", + "required": true, + "type": "string" + }, + { + "name": "workerName", + "in": "path", + "description": "Name of worker machine, typically starts with RD", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites": { + "post": { + "tags": [ + "ServerFarms" + ], + "summary": "Restarts web apps in a specified App Service Plan", + "operationId": "ServerFarms_RestartSitesForServerFarm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "softRestart", + "in": "query", + "description": "Soft restart applies the configuration settings and restarts the apps if necessary. Hard restart always restarts and reprovisions the apps", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}": { + "get": { + "tags": [ + "ServerFarms" + ], + "summary": "Gets a server farm operation", + "operationId": "ServerFarms_GetServerFarmOperation", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of server farm", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Id of Server farm operation\">", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerFarmWithRichSku" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a list of all Virtual Network Connections associated with this web app.", + "operationId": "Sites_GetSiteVNETConnections", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VnetInfo" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a list of all Virtual Network Connections associated with this web app.", + "operationId": "Sites_GetSiteVNETConnectionsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VnetInfo" + } + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a specific Virtual Network Connection associated with this web app.", + "operationId": "Sites_GetSiteVNETConnectionSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Adds a Virtual Network Connection or updates it's properties.", + "operationId": "Sites_CreateOrUpdateSiteVNETConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties of this Virtual Network Connection", + "required": true, + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Removes the specified Virtual Network Connection association from this web app.", + "operationId": "Sites_DeleteSiteVNETConnectionSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Adds a Virtual Network Connection or updates it's properties.", + "operationId": "Sites_UpdateSiteVNETConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties of this Virtual Network Connection", + "required": true, + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a specific Virtual Network Connection associated with this web app.", + "operationId": "Sites_GetSiteVNETConnection", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Adds a Virtual Network Connection or updates it's properties.", + "operationId": "Sites_CreateOrUpdateSiteVNETConnection", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties of this Virtual Network Connection", + "required": true, + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Removes the specified Virtual Network Connection association from this web app.", + "operationId": "Sites_DeleteSiteVNETConnection", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Adds a Virtual Network Connection or updates it's properties.", + "operationId": "Sites_UpdateSiteVNETConnection", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties of this Virtual Network Connection", + "required": true, + "schema": { + "$ref": "#/definitions/VnetInfo" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetInfo" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a view of all network features in use on this web app.", + "operationId": "Sites_GetSiteNetworkFeaturesSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "view", + "in": "path", + "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkFeatures" + } + }, + "404": { + "description": "The requested view does not exist." + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a view of all network features in use on this web app.", + "operationId": "Sites_GetSiteNetworkFeatures", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "view", + "in": "path", + "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkFeatures" + } + }, + "404": { + "description": "The requested view does not exist." + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/operationresults/{operationId}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the operation for a web app", + "operationId": "Sites_GetSiteOperationSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Id of an operation", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/operationresults/{operationId}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the operation for a web app", + "operationId": "Sites_GetSiteOperation", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Id of an operation", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Swaps web app slots", + "operationId": "Sites_SwapSlotWithProduction", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "Request body that contains the target slot name", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Swaps web app slots", + "operationId": "Sites_SwapSlotsSlot", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "Request body that contains the target slot name", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of source slot for the swap", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Get the difference in configuration settings between two web app slots", + "operationId": "Sites_GetSlotsDifferencesFromProduction", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "Request body that contains the target slot name", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SlotDifferenceCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Get the difference in configuration settings between two web app slots", + "operationId": "Sites_GetSlotsDifferencesSlot", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "Request body that contains the target slot name", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the source slot", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SlotDifferenceCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Applies the configuration settings from the target slot onto the current slot", + "operationId": "Sites_ApplySlotConfigToProduction", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "Request body that contains the target slot name. Settings from that slot will be applied on the source slot", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Applies the configuration settings from the target slot onto the current slot", + "operationId": "Sites_ApplySlotConfigSlot", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slotSwapEntity", + "in": "body", + "description": "Request body that contains the target slot name. Settings from that slot will be applied on the source slot", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSlotEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of the source slot. Settings from the target slot will be applied onto this slot", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Resets the configuration settings of the current slot if they were previously modified by calling ApplySlotConfig API", + "operationId": "Sites_ResetProductionSlotConfig", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Resets the configuration settings of the current slot if they were previously modified by calling ApplySlotConfig API", + "operationId": "Sites_ResetSlotConfigSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the names of application settings and connection string that remain with the slot during swap operation", + "operationId": "Sites_GetSlotConfigNames", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SlotConfigNamesResource" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the names of application settings and connection string that remain with the slot during swap operation", + "operationId": "Sites_UpdateSlotConfigNames", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slotConfigNames", + "in": "body", + "description": "Request body containing the names of application settings and connection strings", + "required": true, + "schema": { + "$ref": "#/definitions/SlotConfigNamesResource" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SlotConfigNamesResource" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets all the slots for a web apps", + "operationId": "Sites_GetSiteSlots", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "propertiesToInclude", + "in": "query", + "description": "List of app properties to include in the response", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the web apps for a subscription in the specified resource group", + "operationId": "Sites_GetSites", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "propertiesToInclude", + "in": "query", + "description": "Additional web app properties included in the response", + "type": "string" + }, + { + "name": "includeSiteTypes", + "in": "query", + "description": "Types of apps included in the response", + "type": "string" + }, + { + "name": "includeSlots", + "in": "query", + "description": "Whether or not to include deployments slots in results", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get details of a web app", + "operationId": "Sites_GetSite", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "propertiesToInclude", + "in": "query", + "description": "Additional web app properties included in the response", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Site" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Creates a new web app or modifies an existing web app.", + "operationId": "Sites_CreateOrUpdateSite", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the web app", + "required": true, + "type": "string" + }, + { + "name": "siteEnvelope", + "in": "body", + "description": "Details of web app if it exists already", + "required": true, + "schema": { + "$ref": "#/definitions/Site" + } + }, + { + "name": "skipDnsRegistration", + "in": "query", + "description": "If true web app hostname is not registered with DNS on creation. This parameter is\r\n only used for app creation", + "type": "string" + }, + { + "name": "skipCustomDomainVerification", + "in": "query", + "description": "If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.", + "type": "string" + }, + { + "name": "forceDnsRegistration", + "in": "query", + "description": "If true, web app hostname is force registered with DNS", + "type": "string" + }, + { + "name": "ttlInSeconds", + "in": "query", + "description": "Time to live in seconds for web app's default domain name", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress", + "schema": { + "$ref": "#/definitions/Site" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Deletes a web app", + "operationId": "Sites_DeleteSite", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "deleteMetrics", + "in": "query", + "description": "If true, web app metrics are also deleted", + "type": "string" + }, + { + "name": "deleteEmptyServerFarm", + "in": "query", + "description": "If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted", + "type": "string" + }, + { + "name": "skipDnsRegistration", + "in": "query", + "description": "If true, DNS registration is skipped", + "type": "string" + }, + { + "name": "deleteAllSlots", + "in": "query", + "description": "If true, all slots associated with web app are also deleted", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get details of a web app", + "operationId": "Sites_GetSiteSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "propertiesToInclude", + "in": "query", + "description": "Additional web app properties included in the response", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Site" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Creates a new web app or modifies an existing web app.", + "operationId": "Sites_CreateOrUpdateSiteSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the web app", + "required": true, + "type": "string" + }, + { + "name": "siteEnvelope", + "in": "body", + "description": "Details of web app if it exists already", + "required": true, + "schema": { + "$ref": "#/definitions/Site" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "skipDnsRegistration", + "in": "query", + "description": "If true web app hostname is not registered with DNS on creation. This parameter is\r\n only used for app creation", + "type": "string" + }, + { + "name": "skipCustomDomainVerification", + "in": "query", + "description": "If true, custom (non *.azurewebsites.net) domains associated with web app are not verified.", + "type": "string" + }, + { + "name": "forceDnsRegistration", + "in": "query", + "description": "If true, web app hostname is force registered with DNS", + "type": "string" + }, + { + "name": "ttlInSeconds", + "in": "query", + "description": "Time to live in seconds for web app's default domain name", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Site" + } + }, + "202": { + "description": "Asynchronous operation in progress", + "schema": { + "$ref": "#/definitions/Site" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Deletes a web app", + "operationId": "Sites_DeleteSiteSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "deleteMetrics", + "in": "query", + "description": "If true, web app metrics are also deleted", + "type": "string" + }, + { + "name": "deleteEmptyServerFarm", + "in": "query", + "description": "If true and App Service Plan is empty after web app deletion, App Service Plan is also deleted", + "type": "string" + }, + { + "name": "skipDnsRegistration", + "in": "query", + "description": "If true, DNS registration is skipped", + "type": "string" + }, + { + "name": "deleteAllSlots", + "in": "query", + "description": "If true, all slots associated with web app are also deleted", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Creates a new web app or modifies an existing web app.", + "operationId": "Sites_IsSiteCloneable", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCloneability" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Creates a new web app or modifies an existing web app.", + "operationId": "Sites_IsSiteCloneableSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of the web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteCloneability" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Recovers a deleted web app", + "operationId": "Sites_RecoverSite", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "snapshot", + "in": "body", + "description": "Snapshot data used for web app recovery. Snapshot information can be obtained by call GetDeletedSites API.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSiteRecoveryEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Recovers a deleted web app", + "operationId": "Sites_RecoverSiteSlot", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "snapshot", + "in": "body", + "description": "Snapshot data used for web app recovery. Snapshot information can be obtained by call GetDeletedSites API.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmSiteRecoveryEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restorableSnapshots": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Returns Snapshots to the user based on their SKU.", + "operationId": "Sites_GetSiteSnapshotsOnSkuSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "subscriptionName", + "in": "query", + "description": "Azure subscription", + "required": true, + "type": "string" + }, + { + "name": "webspaceName", + "in": "query", + "description": "Webspace", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Website Name", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restorableSnapshots": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Returns Snapshots to the user based on their SKU.", + "operationId": "Sites_GetSiteSnapshotsOnSku", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "subscriptionName", + "in": "query", + "description": "Azure subscription", + "required": true, + "type": "string" + }, + { + "name": "webspaceName", + "in": "query", + "description": "Webspace", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Website Name", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Returns all Snapshots to the user.", + "operationId": "Sites_GetSiteSnapshots", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "subscriptionName", + "in": "query", + "description": "Azure subscription", + "required": true, + "type": "string" + }, + { + "name": "webspaceName", + "in": "query", + "description": "Webspace", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Website Name", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Returns all Snapshots to the user.", + "operationId": "Sites_GetSiteSnapshotsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "subscriptionName", + "in": "query", + "description": "Azure subscription", + "required": true, + "type": "string" + }, + { + "name": "webspaceName", + "in": "query", + "description": "Webspace", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Website Name", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/deletedSites": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets deleted web apps in subscription", + "operationId": "Sites_GetDeletedSites", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "propertiesToInclude", + "in": "query", + "description": "Additional web app properties included in the response", + "type": "string" + }, + { + "name": "includeSiteTypes", + "in": "query", + "description": "Types of apps included in the response", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeletedSiteCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": { + "get": { + "tags": [ + "Sites" + ], + "summary": "List deployments", + "operationId": "Sites_GetDeploymentsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeploymentCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": { + "get": { + "tags": [ + "Sites" + ], + "summary": "List deployments", + "operationId": "Sites_GetDeployments", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeploymentCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments": { + "get": { + "tags": [ + "Sites" + ], + "summary": "List deployments", + "operationId": "Sites_GetInstanceDeployments", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeploymentCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments": { + "get": { + "tags": [ + "Sites" + ], + "summary": "List deployments", + "operationId": "Sites_GetInstanceDeploymentsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeploymentCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get the deployment", + "operationId": "Sites_GetInstanceDeploymentSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Create a deployment", + "operationId": "Sites_CreateInstanceDeploymentSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, + { + "name": "deployment", + "in": "body", + "description": "Details of deployment", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Delete the deployment", + "operationId": "Sites_DeleteInstanceDeploymentSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get the deployment", + "operationId": "Sites_GetDeployment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Create a deployment", + "operationId": "Sites_CreateDeployment", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "deployment", + "in": "body", + "description": "Details of deployment", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Delete the deployment", + "operationId": "Sites_DeleteDeployment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get the deployment", + "operationId": "Sites_GetDeploymentSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Create a deployment", + "operationId": "Sites_CreateDeploymentSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "deployment", + "in": "body", + "description": "Details of deployment", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Delete the deployment", + "operationId": "Sites_DeleteDeploymentSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get the deployment", + "operationId": "Sites_GetInstanceDeployment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Create a deployment", + "operationId": "Sites_CreateInstanceDeployment", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, + { + "name": "deployment", + "in": "body", + "description": "Details of deployment", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Deployment" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Delete the deployment", + "operationId": "Sites_DeleteInstanceDeployment", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets all instance of a web app", + "operationId": "Sites_GetSiteInstanceIdentifiers", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteInstanceCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets all instance of a web app", + "operationId": "Sites_GetSiteInstanceIdentifiersSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteInstanceCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get web app hostname bindings", + "operationId": "Sites_GetSiteHostNameBindings", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBindingCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get web app hostname bindings", + "operationId": "Sites_GetSiteHostNameBindingsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBindingCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get web app binding for a hostname", + "operationId": "Sites_GetSiteHostNameBinding", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Creates a web app hostname binding", + "operationId": "Sites_CreateOrUpdateSiteHostNameBinding", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, + { + "name": "hostNameBinding", + "in": "body", + "description": "Host name binding information", + "required": true, + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Deletes a host name binding", + "operationId": "Sites_DeleteSiteHostNameBinding", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get web app binding for a hostname", + "operationId": "Sites_GetSiteHostNameBindingSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Creates a web app hostname binding", + "operationId": "Sites_CreateOrUpdateSiteHostNameBindingSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, + { + "name": "hostNameBinding", + "in": "body", + "description": "Host name binding information", + "required": true, + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HostNameBinding" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Deletes a host name binding", + "operationId": "Sites_DeleteSiteHostNameBindingSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the configuration of the web app", + "operationId": "Sites_GetSiteConfig", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfig" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Update the configuration of web app", + "operationId": "Sites_CreateOrUpdateSiteConfig", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteConfig", + "in": "body", + "description": "Request body that contains the configuraiton setting for the web app", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfig" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfig" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Update the configuration of web app", + "operationId": "Sites_UpdateSiteConfig", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteConfig", + "in": "body", + "description": "Request body that contains the configuraiton setting for the web app", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfig" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfig" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the configuration of the web app", + "operationId": "Sites_GetSiteConfigSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfig" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Update the configuration of web app", + "operationId": "Sites_CreateOrUpdateSiteConfigSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteConfig", + "in": "body", + "description": "Request body that contains the configuraiton setting for the web app", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfig" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfig" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Update the configuration of web app", + "operationId": "Sites_UpdateSiteConfigSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteConfig", + "in": "body", + "description": "Request body that contains the configuraiton setting for the web app", + "required": true, + "schema": { + "$ref": "#/definitions/SiteConfig" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteConfig" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get the source control configuration of web app", + "operationId": "Sites_GetSiteSourceControlSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Update the source control configuration of web app", + "operationId": "Sites_CreateOrUpdateSiteSourceControlSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "Request body that contains the source control parameters", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Delete source control configuration of web app", + "operationId": "Sites_DeleteSiteSourceControlSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Update the source control configuration of web app", + "operationId": "Sites_UpdateSiteSourceControlSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "Request body that contains the source control parameters", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Get the source control configuration of web app", + "operationId": "Sites_GetSiteSourceControl", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Update the source control configuration of web app", + "operationId": "Sites_CreateOrUpdateSiteSourceControl", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "Request body that contains the source control parameters", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Delete source control configuration of web app", + "operationId": "Sites_DeleteSiteSourceControl", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Update the source control configuration of web app", + "operationId": "Sites_UpdateSiteSourceControl", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteSourceControl", + "in": "body", + "description": "Request body that contains the source control parameters", + "required": true, + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the application settings of web app", + "operationId": "Sites_ListSiteAppSettings", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the application settings of web app", + "operationId": "Sites_ListSiteAppSettingsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the application settings of web app", + "operationId": "Sites_UpdateSiteAppSettings", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "appSettings", + "in": "body", + "description": "Application settings of web app", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the application settings of web app", + "operationId": "Sites_UpdateSiteAppSettingsSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "appSettings", + "in": "body", + "description": "Application settings of web app", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the connection strings associated with web app", + "operationId": "Sites_ListSiteConnectionStrings", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the connection strings associated with web app", + "operationId": "Sites_ListSiteConnectionStringsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the connection strings associated with web app", + "operationId": "Sites_UpdateSiteConnectionStrings", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "connectionStrings", + "in": "body", + "description": "Connection strings associated with web app", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the connection strings associated with web app", + "operationId": "Sites_UpdateSiteConnectionStringsSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "connectionStrings", + "in": "body", + "description": "Connection strings associated with web app", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the Authentication / Authorization settings associated with web app", + "operationId": "Sites_ListSiteAuthSettings", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the Authentication / Authorization settings associated with web app", + "operationId": "Sites_ListSiteAuthSettingsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the Authentication / Authorization settings associated with web app", + "operationId": "Sites_UpdateSiteAuthSettings", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteAuthSettings", + "in": "body", + "description": "Auth settings associated with web app", + "required": true, + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the Authentication / Authorization settings associated with web app", + "operationId": "Sites_UpdateSiteAuthSettingsSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteAuthSettings", + "in": "body", + "description": "Auth settings associated with web app", + "required": true, + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteAuthSettings" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the web app publishing credentials", + "operationId": "Sites_ListSitePublishingCredentials", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/User" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the web app publishing credentials", + "operationId": "Sites_ListSitePublishingCredentialsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/User" + } + } + }, + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the web app meta data.", + "operationId": "Sites_ListSiteMetadata", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the web app meta data.", + "operationId": "Sites_ListSiteMetadataSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the meta data for web app", + "operationId": "Sites_UpdateSiteMetadata", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "Meta data of web app", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the meta data for web app", + "operationId": "Sites_UpdateSiteMetadataSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "Meta data of web app", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StringDictionary" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the web app logs configuration", + "operationId": "Sites_GetSiteLogsConfig", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the meta data for web app", + "operationId": "Sites_UpdateSiteLogsConfig", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteLogsConfig", + "in": "body", + "description": "Site logs configuration", + "required": true, + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the web app logs configuration", + "operationId": "Sites_GetSiteLogsConfigSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the meta data for web app", + "operationId": "Sites_UpdateSiteLogsConfigSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "siteLogsConfig", + "in": "body", + "description": "Site logs configuration", + "required": true, + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": { + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_ListSitePremierAddOnsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_ListSitePremierAddOns", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": { + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_GetSitePremierAddOnSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "operationId": "Sites_AddSitePremierAddOnSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "premierAddOn", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOnRequest" + } + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "operationId": "Sites_DeleteSitePremierAddOnSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { + "get": { + "tags": [ + "Sites" + ], + "operationId": "Sites_GetSitePremierAddOn", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "operationId": "Sites_AddSitePremierAddOn", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "premierAddOn", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PremierAddOnRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "operationId": "Sites_DeleteSitePremierAddOn", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "premierAddOnName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the backup configuration for a web app", + "operationId": "Sites_GetSiteBackupConfiguration", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the backup configuration for a web app", + "operationId": "Sites_GetSiteBackupConfigurationSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates backup configuration of web app", + "operationId": "Sites_UpdateSiteBackupConfiguration", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates backup configuration of web app", + "operationId": "Sites_UpdateSiteBackupConfigurationSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Creates web app backup", + "operationId": "Sites_BackupSite", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Creates web app backup", + "operationId": "Sites_BackupSiteSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Discovers existing web app backups that can be restored", + "operationId": "Sites_DiscoverSiteRestore", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover": { + "put": { + "tags": [ + "Sites" + ], + "summary": "Discovers existing web app backups that can be restored", + "operationId": "Sites_DiscoverSiteRestoreSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Lists all available backups for web app", + "operationId": "Sites_ListSiteBackups", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItemCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Lists all available backups for web app", + "operationId": "Sites_ListSiteBackupsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItemCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets status of a web app backup that may be in progress.", + "operationId": "Sites_GetSiteBackupStatus", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Deletes a backup from Azure Storage", + "operationId": "Sites_DeleteBackup", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets status of a web app backup that may be in progress.", + "operationId": "Sites_GetSiteBackupStatusSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Deletes a backup from Azure Storage", + "operationId": "Sites_DeleteBackupSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", + "operationId": "Sites_GetSiteBackupStatusSecretsSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.", + "operationId": "Sites_GetSiteBackupStatusSecrets", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupItem" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Restores a web app", + "operationId": "Sites_RestoreSite", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup to restore", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestoreResponse" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Restores a web app", + "operationId": "Sites_RestoreSiteSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup to restore", + "required": true, + "type": "string" + }, + { + "name": "request", + "in": "body", + "description": "Information on restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RestoreResponse" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the quota usage numbers for web app", + "operationId": "Sites_GetSiteUsages", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmUsageQuotaCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets the quota usage numbers for web app", + "operationId": "Sites_GetSiteUsagesSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages specified in the filter. Filter is specified by using OData syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmUsageQuotaCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets metrics for web app", + "operationId": "Sites_GetSiteMetrics", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "If true, metric details are included in response", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets metrics for web app", + "operationId": "Sites_GetSiteMetricsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "details", + "in": "query", + "description": "If true, metric details are included in response", + "type": "boolean" + }, + { + "name": "$filter", + "in": "query", + "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq '2014-01-01T00:00:00Z' and endTime eq '2014-12-31T23:59:59Z' and timeGrain eq duration'[Hour|Minute|Day]'.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceMetricCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets metric definitions for web app", + "operationId": "Sites_GetSiteMetricDefinitionsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Gets metric definitions for web app", + "operationId": "Sites_GetSiteMetricDefinitions", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the publishing profile for web app", + "operationId": "Sites_ListSitePublishingProfileXml", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "options", + "in": "body", + "description": "Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmPublishingProfileOptions" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Gets the publishing profile for web app", + "operationId": "Sites_ListSitePublishingProfileXmlSlot", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "options", + "in": "body", + "description": "Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format.", + "required": true, + "schema": { + "$ref": "#/definitions/CsmPublishingProfileOptions" + } + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Restarts web app", + "operationId": "Sites_RestartSite", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "softRestart", + "in": "query", + "description": "Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app", + "type": "boolean" + }, + { + "name": "synchronous", + "in": "query", + "description": "If true then the API will block until the app has been restarted", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Restarts web app", + "operationId": "Sites_RestartSiteSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "name": "softRestart", + "in": "query", + "description": "Soft restart applies the configuration settings and restarts the app if necessary. Hard restart always restarts and reprovisions the app", + "type": "boolean" + }, + { + "name": "synchronous", + "in": "query", + "description": "If true then the API will block until the app has been restarted", + "type": "boolean" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Starts web app", + "operationId": "Sites_StartSite", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Starts web app", + "operationId": "Sites_StartSiteSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Stops web app", + "operationId": "Sites_StopSite", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Stops web app", + "operationId": "Sites_StopSiteSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": { + "post": { + "tags": [ + "Sites" + ], + "operationId": "Sites_SyncSiteRepository", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": { + "post": { + "tags": [ + "Sites" + ], + "operationId": "Sites_SyncSiteRepositorySlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Generates new random app publishing password", + "operationId": "Sites_GenerateNewSitePublishingPasswordSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { + "post": { + "tags": [ + "Sites" + ], + "summary": "Generates new random app publishing password", + "operationId": "Sites_GenerateNewSitePublishingPassword", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", + "operationId": "Sites_GetSiteRelayServiceConnection", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "The name by which the Hybrid Connection is identified", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnection", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "The name by which the Hybrid Connection is identified", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the Hybrid Connection", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", + "operationId": "Sites_DeleteSiteRelayServiceConnection", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "The name by which the Hybrid Connection is identified", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "operationId": "Sites_UpdateSiteRelayServiceConnection", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "The name by which the Hybrid Connection is identified", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the Hybrid Connection", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", + "operationId": "Sites_GetSiteRelayServiceConnectionSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "The name by which the Hybrid Connection is identified", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "The name by which the Hybrid Connection is identified", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the Hybrid Connection", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Sites" + ], + "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", + "operationId": "Sites_DeleteSiteRelayServiceConnectionSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "The name by which the Hybrid Connection is identified", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "operationId": "Sites_UpdateSiteRelayServiceConnectionSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "entityName", + "in": "path", + "description": "The name by which the Hybrid Connection is identified", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The details of the Hybrid Connection", + "required": true, + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", + "operationId": "Sites_ListSiteRelayServiceConnections", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", + "operationId": "Sites_ListSiteRelayServiceConnectionsSlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a Virtual Network connection gateway associated with this web app and virtual network.", + "operationId": "Sites_GetSiteVnetGateway", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "404": { + "description": "Gateway does not exist. Only the \"primary\" gateway exists presently." + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the Virtual Network Gateway.", + "operationId": "Sites_CreateOrUpdateSiteVNETConnectionGateway", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Updates the Virtual Network Gateway.", + "operationId": "Sites_UpdateSiteVNETConnectionGateway", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { + "tags": [ + "Sites" + ], + "summary": "Retrieves a Virtual Network connection gateway associated with this web app and virtual network.", + "operationId": "Sites_GetSiteVnetGatewaySlot", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "404": { + "description": "Gateway does not exist. Only the \"primary\" gateway exists presently." + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Sites" + ], + "summary": "Updates the Virtual Network Gateway.", + "operationId": "Sites_CreateOrUpdateSiteVNETConnectionGatewaySlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Sites" + ], + "summary": "Updates the Virtual Network Gateway.", + "operationId": "Sites_UpdateSiteVNETConnectionGatewaySlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "The name of the Virtual Network", + "required": true, + "type": "string" + }, + { + "name": "gatewayName", + "in": "path", + "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", + "required": true, + "type": "string" + }, + { + "name": "connectionEnvelope", + "in": "body", + "description": "The properties to update this gateway with.", + "required": true, + "schema": { + "$ref": "#/definitions/VnetGateway" + } + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VnetGateway" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains": { + "get": { + "tags": [ + "TopLevelDomains" + ], + "summary": "Lists all top level domains supported for registration", + "operationId": "TopLevelDomains_GetGetTopLevelDomains", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopLevelDomainCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}": { + "get": { + "tags": [ + "TopLevelDomains" + ], + "summary": "Gets details of a top level domain", + "operationId": "TopLevelDomains_GetTopLevelDomain", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the top level domain", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopLevelDomain" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements": { + "post": { + "tags": [ + "TopLevelDomains" + ], + "summary": "Lists legal agreements that user needs to accept before purchasing domain", + "operationId": "TopLevelDomains_ListTopLevelDomainAgreements", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the top level domain", + "required": true, + "type": "string" + }, + { + "name": "agreementOption", + "in": "body", + "description": "Domain agreement options", + "required": true, + "schema": { + "$ref": "#/definitions/TopLevelDomainAgreementOption" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TldLegalAgreementCollection" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web.Admin/environments/{environmentName}/usage": { + "get": { + "tags": [ + "Usage" + ], + "summary": "Returns usage records for specified subscription and resource groups", + "operationId": "Usage_GetUsage", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name", + "required": true, + "type": "string" + }, + { + "name": "lastId", + "in": "query", + "description": "Last marker that was returned from the batch", + "required": true, + "type": "string" + }, + { + "name": "batchSize", + "in": "query", + "description": "size of the batch to be returned.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Object" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "CertificateCollection": { + "description": "Collection of certificates", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "Certificate": { + "description": "App certificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "friendlyName": { + "description": "Friendly name of the certificate", + "type": "string" + }, + "subjectName": { + "description": "Subject name of the certificate", + "type": "string" + }, + "hostNames": { + "description": "Host names the certificate applies to", + "type": "array", + "items": { + "type": "string" + } + }, + "pfxBlob": { + "description": "Pfx blob", + "type": "string" + }, + "siteName": { + "description": "App name", + "type": "string" + }, + "selfLink": { + "description": "Self link", + "type": "string" + }, + "issuer": { + "description": "Certificate issuer", + "type": "string" + }, + "issueDate": { + "format": "date-time", + "description": "Certificate issue Date", + "type": "string" + }, + "expirationDate": { + "format": "date-time", + "description": "Certificate expriration date", + "type": "string" + }, + "password": { + "description": "Certificate password", + "type": "string" + }, + "thumbprint": { + "description": "Certificate thumbprint", + "type": "string" + }, + "valid": { + "description": "Is the certificate valid?", + "type": "boolean" + }, + "cerBlob": { + "description": "Raw bytes of .cer file", + "type": "string" + }, + "publicKeyHash": { + "description": "Public key hash", + "type": "string" + }, + "hostingEnvironmentProfile": { + "$ref": "#/definitions/HostingEnvironmentProfile", + "description": "Specification for the hosting environment (App Service Environment) to use for the certificate" + } + }, + "x-ms-client-flatten": true + } + } + }, + "HostingEnvironmentProfile": { + "description": "Specification for a hostingEnvironment (App Service Environment) to use for this resource", + "type": "object", + "properties": { + "id": { + "description": "Resource id of the hostingEnvironment (App Service Environment)", + "type": "string" + }, + "name": { + "description": "Name of the hostingEnvironment (App Service Environment) (read only)", + "type": "string" + }, + "type": { + "description": "Resource type of the hostingEnvironment (App Service Environment) (read only)", + "type": "string" + } + } + }, + "ArmPlan": { + "description": "The plan object in an ARM, represents a marketplace plan", + "type": "object", + "properties": { + "name": { + "description": "The name", + "type": "string" + }, + "publisher": { + "description": "The publisher", + "type": "string" + }, + "product": { + "description": "The product", + "type": "string" + }, + "promotionCode": { + "description": "The promotion code", + "type": "string" + }, + "version": { + "description": "Version of product", + "type": "string" + } + } + }, + "SkuDescription": { + "description": "Describes a sku for a scalable resource", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource sku", + "type": "string" + }, + "tier": { + "description": "Service Tier of the resource sku", + "type": "string" + }, + "size": { + "description": "Size specifier of the resource sku", + "type": "string" + }, + "family": { + "description": "Family code of the resource sku", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Current number of instances assigned to the resource", + "type": "integer" + } + } + }, + "Object": { + "type": "object", + "properties": {} + }, + "Csr": { + "description": "Certificate signing request object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Name used to locate CSR object", + "type": "string" + }, + "distinguishedName": { + "description": "Distinguished name of certificate to be created", + "type": "string" + }, + "csrString": { + "description": "Actual CSR string created", + "type": "string" + }, + "pfxBlob": { + "description": "PFX certifcate of created certificate", + "type": "string" + }, + "password": { + "description": "PFX password", + "type": "string" + }, + "publicKeyHash": { + "description": "Hash of the certificates public key", + "type": "string" + }, + "hostingEnvironment": { + "description": "Hosting environment", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ClassicMobileServiceCollection": { + "description": "Collection of Classic Mobile Services", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/ClassicMobileService" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "ClassicMobileService": { + "description": "A mobile service", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Name of the mobile service", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "DomainCollection": { + "description": "Collection of domains", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/Domain" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "Domain": { + "description": "Represents a domain", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "contactAdmin": { + "$ref": "#/definitions/Contact", + "description": "Admin contact information" + }, + "contactBilling": { + "$ref": "#/definitions/Contact", + "description": "Billing contact information" + }, + "contactRegistrant": { + "$ref": "#/definitions/Contact", + "description": "Registrant contact information" + }, + "contactTech": { + "$ref": "#/definitions/Contact", + "description": "Technical contact information" + }, + "registrationStatus": { + "description": "Domain registration status", + "enum": [ + "Active", + "Awaiting", + "Cancelled", + "Confiscated", + "Disabled", + "Excluded", + "Expired", + "Failed", + "Held", + "Locked", + "Parked", + "Pending", + "Reserved", + "Reverted", + "Suspended", + "Transferred", + "Unknown", + "Unlocked", + "Unparked", + "Updated", + "JsonConverterFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainStatus", + "modelAsString": false + } + }, + "provisioningState": { + "description": "Domain provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "nameServers": { + "description": "Name servers", + "type": "array", + "items": { + "type": "string" + } + }, + "privacy": { + "description": "If true then domain privacy is enabled for this domain", + "type": "boolean" + }, + "createdTime": { + "format": "date-time", + "description": "Domain creation timestamp", + "type": "string" + }, + "expirationTime": { + "format": "date-time", + "description": "Domain expiration timestamp", + "type": "string" + }, + "lastRenewedTime": { + "format": "date-time", + "description": "Timestamp when the domain was renewed last time", + "type": "string" + }, + "autoRenew": { + "description": "If true then domain will renewed automatically", + "type": "boolean" + }, + "readyForDnsRecordManagement": { + "description": "If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to", + "type": "boolean" + }, + "managedHostNames": { + "description": "All hostnames derived from the domain and assigned to Azure resources", + "type": "array", + "items": { + "$ref": "#/definitions/HostName" + } + }, + "consent": { + "$ref": "#/definitions/DomainPurchaseConsent", + "description": "Legal agreement consent" + } + }, + "x-ms-client-flatten": true + } + } + }, + "Contact": { + "description": "Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be be made publicly available through the Whois directories as per ICANN requirements.", + "type": "object", + "properties": { + "addressMailing": { + "$ref": "#/definitions/Address", + "description": "Mailing address" + }, + "email": { + "description": "Email address", + "type": "string" + }, + "fax": { + "description": "Fax number", + "type": "string" + }, + "jobTitle": { + "description": "Job title", + "type": "string" + }, + "nameFirst": { + "description": "First name", + "type": "string" + }, + "nameLast": { + "description": "Last name", + "type": "string" + }, + "nameMiddle": { + "description": "Middle name", + "type": "string" + }, + "organization": { + "description": "Organization", + "type": "string" + }, + "phone": { + "description": "Phone number", + "type": "string" + } + } + }, + "HostName": { + "description": "Details of a hostname derived from a domain", + "type": "object", + "properties": { + "name": { + "description": "Name of the hostname", + "type": "string" + }, + "siteNames": { + "description": "List of sites the hostname is assigned to. This list will have more than one site only if the hostname is pointing to a Traffic Manager", + "type": "array", + "items": { + "type": "string" + } + }, + "azureResourceName": { + "description": "Name of the Azure resource the hostname is assigned to. If it is assigned to a traffic manager then it will be the traffic manager name otherwise it will be the website name", + "type": "string" + }, + "azureResourceType": { + "description": "Type of the Azure resource the hostname is assigned to", + "enum": [ + "Website", + "TrafficManager" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureResourceType", + "modelAsString": false + } + }, + "customHostNameDnsRecordType": { + "description": "Type of the Dns record", + "enum": [ + "CName", + "A" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHostNameDnsRecordType", + "modelAsString": false + } + }, + "hostNameType": { + "description": "Type of the hostname", + "enum": [ + "Verified", + "Managed" + ], + "type": "string", + "x-ms-enum": { + "name": "HostNameType", + "modelAsString": false + } + } + } + }, + "DomainPurchaseConsent": { + "description": "Domain purchase consent object representing acceptance of applicable legal agreements", + "type": "object", + "properties": { + "agreementKeys": { + "description": "List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements Api under TopLevelDomain resource", + "type": "array", + "items": { + "type": "string" + } + }, + "agreedBy": { + "description": "Client IP address", + "type": "string" + }, + "agreedAt": { + "format": "date-time", + "description": "Timestamp when the agreements were accepted", + "type": "string" + } + } + }, + "Address": { + "description": "Address information for domain registration", + "type": "object", + "properties": { + "address1": { + "description": "Address 1", + "type": "string" + }, + "address2": { + "description": "Address 2", + "type": "string" + }, + "city": { + "description": "City", + "type": "string" + }, + "country": { + "description": "Country", + "type": "string" + }, + "postalCode": { + "description": "Postal code", + "type": "string" + }, + "state": { + "description": "State", + "type": "string" + } + } + }, + "User": { + "description": "Represents user crendentials used for publishing activity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Username (internal)", + "type": "string" + }, + "publishingUserName": { + "description": "Username used for publishing", + "type": "string" + }, + "publishingPassword": { + "description": "Password used for publishing", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "GeoRegionCollection": { + "description": "Collection of geo regions", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/GeoRegion" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "GeoRegion": { + "description": "Geographical region", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Region name", + "type": "string" + }, + "description": { + "description": "Region description", + "type": "string" + }, + "displayName": { + "description": "Display name for region", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ServerFarmCollection": { + "description": "Collection of serverfarms", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/ServerFarmWithRichSku" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "ServerFarmWithRichSku": { + "description": "App Service Plan Model", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "required": [ + "status" + ], + "properties": { + "name": { + "description": "Name for the App Service Plan", + "type": "string" + }, + "workerTierName": { + "description": "Target worker tier assigned to the App Service Plan", + "type": "string" + }, + "status": { + "description": "App Service Plan Status", + "enum": [ + "Ready", + "Pending" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StatusOptions", + "modelAsString": false + } + }, + "subscription": { + "description": "App Service Plan Subscription", + "type": "string", + "readOnly": true + }, + "adminSiteName": { + "description": "App Service Plan administration site", + "type": "string" + }, + "hostingEnvironmentProfile": { + "$ref": "#/definitions/HostingEnvironmentProfile", + "description": "Specification for the hosting environment (App Service Environment) to use for the App Service Plan" + }, + "maximumNumberOfWorkers": { + "format": "int32", + "description": "Maximum number of instances that can be assigned to this App Service Plan", + "type": "integer" + }, + "geoRegion": { + "description": "Geographical location for the App Service Plan", + "type": "string", + "readOnly": true + }, + "perSiteScaling": { + "description": "If True apps assigned to this App Service Plan can be scaled independently\r\n If False apps assigned to this App Service Plan will scale to all instances of the plan", + "type": "boolean" + }, + "numberOfSites": { + "format": "int32", + "description": "Number of web apps assigned to this App Service Plan", + "type": "integer", + "readOnly": true + }, + "resourceGroup": { + "description": "Resource group of the serverfarm", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/SkuDescription" + } + } + }, + "SiteCollection": { + "description": "Collection of sites", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/Site" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "Site": { + "description": "Represents a web app", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "required": [ + "usageState", + "availabilityState" + ], + "properties": { + "name": { + "description": "Name of web app", + "type": "string" + }, + "state": { + "description": "State of the web app", + "type": "string", + "readOnly": true + }, + "hostNames": { + "description": "Hostnames associated with web app", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "repositorySiteName": { + "description": "Name of repository site", + "type": "string", + "readOnly": true + }, + "usageState": { + "description": "State indicating whether web app has exceeded its quota usage", + "enum": [ + "Normal", + "Exceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UsageState", + "modelAsString": false + } + }, + "enabled": { + "description": "True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line).", + "type": "boolean" + }, + "enabledHostNames": { + "description": "Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled\r\n the app is not served on those hostnames", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "availabilityState": { + "description": "Management information availability state for the web app. Possible values are Normal or Limited. \r\n Normal means that the site is running correctly and that management information for the site is available. \r\n Limited means that only partial management information for the site is available and that detailed site information is unavailable.", + "enum": [ + "Normal", + "Limited", + "DisasterRecoveryMode" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SiteAvailabilityState", + "modelAsString": false + } + }, + "hostNameSslStates": { + "description": "Hostname SSL states are used to manage the SSL bindings for site's hostnames.", + "type": "array", + "items": { + "$ref": "#/definitions/HostNameSslState" + } + }, + "serverFarmId": { + "type": "string" + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "Last time web app was modified in UTC", + "type": "string", + "readOnly": true + }, + "siteConfig": { + "$ref": "#/definitions/SiteConfig", + "description": "Configuration of web app" + }, + "trafficManagerHostNames": { + "description": "Read-only list of Azure Traffic manager hostnames associated with web app", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "premiumAppDeployed": { + "description": "If set indicates whether web app is deployed as a premium app", + "type": "boolean", + "readOnly": true + }, + "scmSiteAlsoStopped": { + "description": "If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false.", + "type": "boolean" + }, + "targetSwapSlot": { + "description": "Read-only property that specifies which slot this app will swap into", + "type": "string", + "readOnly": true + }, + "hostingEnvironmentProfile": { + "$ref": "#/definitions/HostingEnvironmentProfile", + "description": "Specification for the hosting environment (App Service Environment) to use for the web app" + }, + "microService": { + "description": "", + "type": "string" + }, + "gatewaySiteName": { + "description": "Name of gateway app associated with web app", + "type": "string" + }, + "clientAffinityEnabled": { + "description": "Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app", + "type": "boolean" + }, + "clientCertEnabled": { + "description": "Specifies if the client certificate is enabled for the web app", + "type": "boolean" + }, + "hostNamesDisabled": { + "description": "Specifies if the public hostnames are disabled the web app.\r\n If set to true the app is only accessible via API Management process", + "type": "boolean" + }, + "outboundIpAddresses": { + "description": "List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.", + "type": "string", + "readOnly": true + }, + "containerSize": { + "format": "int32", + "description": "Size of a function container", + "type": "integer" + }, + "maxNumberOfWorkers": { + "format": "int32", + "description": "Maximum number of workers\r\n This only applies to function container", + "type": "integer" + }, + "cloningInfo": { + "$ref": "#/definitions/CloningInfo", + "description": "This is only valid for web app creation. If specified, web app is cloned from \r\n a source web app" + }, + "resourceGroup": { + "description": "Resource group web app belongs to", + "type": "string", + "readOnly": true + }, + "isDefaultContainer": { + "description": "Site is a default container", + "type": "boolean", + "readOnly": true + }, + "defaultHostName": { + "description": "Default hostname of the web app", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteProperties": { + "type": "object", + "properties": { + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + } + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + } + }, + "appSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + } + } + } + }, + "HostNameSslState": { + "description": "Object that represents a SSL-enabled host name.", + "required": [ + "sslState" + ], + "type": "object", + "properties": { + "name": { + "description": "Host name", + "type": "string" + }, + "sslState": { + "description": "SSL type", + "enum": [ + "Disabled", + "SniEnabled", + "IpBasedEnabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SslState", + "modelAsString": false + } + }, + "virtualIP": { + "description": "Virtual IP address assigned to the host name if IP based SSL is enabled", + "type": "string" + }, + "thumbprint": { + "description": "SSL cert thumbprint", + "type": "string" + }, + "toUpdate": { + "description": "Set this flag to update existing host name", + "type": "boolean" + } + } + }, + "SiteConfig": { + "description": "Configuration of Azure web site", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "numberOfWorkers": { + "format": "int32", + "description": "Number of workers", + "type": "integer" + }, + "defaultDocuments": { + "description": "Default documents", + "type": "array", + "items": { + "type": "string" + } + }, + "netFrameworkVersion": { + "description": "Net Framework Version", + "type": "string" + }, + "phpVersion": { + "description": "Version of PHP", + "type": "string" + }, + "pythonVersion": { + "description": "Version of Python", + "type": "string" + }, + "requestTracingEnabled": { + "description": "Enable request tracing", + "type": "boolean" + }, + "requestTracingExpirationTime": { + "format": "date-time", + "description": "Request tracing expiration time", + "type": "string" + }, + "remoteDebuggingEnabled": { + "description": "Remote Debugging Enabled", + "type": "boolean" + }, + "remoteDebuggingVersion": { + "description": "Remote Debugging Version", + "type": "string" + }, + "httpLoggingEnabled": { + "description": "HTTP logging Enabled", + "type": "boolean" + }, + "logsDirectorySizeLimit": { + "format": "int32", + "description": "HTTP Logs Directory size limit", + "type": "integer" + }, + "detailedErrorLoggingEnabled": { + "description": "Detailed error logging enabled", + "type": "boolean" + }, + "publishingUsername": { + "description": "Publishing user name", + "type": "string" + }, + "publishingPassword": { + "description": "Publishing password", + "type": "string" + }, + "appSettings": { + "description": "Application Settings", + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + } + }, + "metadata": { + "description": "Site Metadata", + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + } + }, + "connectionStrings": { + "description": "Connection strings", + "type": "array", + "items": { + "$ref": "#/definitions/ConnStringInfo" + } + }, + "handlerMappings": { + "description": "Handler mappings", + "type": "array", + "items": { + "$ref": "#/definitions/HandlerMapping" + } + }, + "documentRoot": { + "description": "Document root", + "type": "string" + }, + "scmType": { + "description": "SCM type", + "type": "string" + }, + "use32BitWorkerProcess": { + "description": "Use 32 bit worker process", + "type": "boolean" + }, + "webSocketsEnabled": { + "description": "Web socket enabled.", + "type": "boolean" + }, + "alwaysOn": { + "description": "Always On", + "type": "boolean" + }, + "javaVersion": { + "description": "Java version", + "type": "string" + }, + "javaContainer": { + "description": "Java container", + "type": "string" + }, + "javaContainerVersion": { + "description": "Java container version", + "type": "string" + }, + "managedPipelineMode": { + "description": "Managed pipeline mode", + "enum": [ + "Integrated", + "Classic" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedPipelineMode", + "modelAsString": false + } + }, + "virtualApplications": { + "description": "Virtual applications", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplication" + } + }, + "loadBalancing": { + "description": "Site load balancing", + "enum": [ + "WeightedRoundRobin", + "LeastRequests", + "LeastResponseTime", + "WeightedTotalTraffic", + "RequestHash" + ], + "type": "string", + "x-ms-enum": { + "name": "SiteLoadBalancing", + "modelAsString": false + } + }, + "experiments": { + "$ref": "#/definitions/Experiments", + "description": "This is work around for polymophic types" + }, + "limits": { + "$ref": "#/definitions/SiteLimits", + "description": "Site limits" + }, + "autoHealEnabled": { + "description": "Auto heal enabled", + "type": "boolean" + }, + "autoHealRules": { + "$ref": "#/definitions/AutoHealRules", + "description": "Auto heal rules" + }, + "tracingOptions": { + "description": "Tracing options", + "type": "string" + }, + "vnetName": { + "description": "Vnet name", + "type": "string" + }, + "cors": { + "$ref": "#/definitions/CorsSettings", + "description": "Cross-Origin Resource Sharing (CORS) settings." + }, + "apiDefinition": { + "$ref": "#/definitions/ApiDefinitionInfo", + "description": "Information about the formal API definition for the web app." + }, + "autoSwapSlotName": { + "description": "Auto swap slot name", + "type": "string" + }, + "localMySqlEnabled": { + "description": "Local mysql enabled", + "type": "boolean" + }, + "ipSecurityRestrictions": { + "description": "Ip Security restrictions", + "type": "array", + "items": { + "$ref": "#/definitions/IpSecurityRestriction" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "CloningInfo": { + "description": "Represents information needed for cloning operation", + "type": "object", + "properties": { + "correlationId": { + "description": "Correlation Id of cloning operation. This id ties multiple cloning operations\r\n together to use the same snapshot", + "type": "string" + }, + "overwrite": { + "description": "Overwrite destination web app", + "type": "boolean" + }, + "cloneCustomHostNames": { + "description": "If true, clone custom hostnames from source web app", + "type": "boolean" + }, + "cloneSourceControl": { + "description": "Clone source control from source web app", + "type": "boolean" + }, + "sourceWebAppId": { + "description": "ARM resource id of the source web app. Web app resource id is of the form \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots", + "type": "string" + }, + "hostingEnvironment": { + "description": "Hosting environment", + "type": "string" + }, + "appSettingsOverrides": { + "description": "Application settings overrides for cloned web app. If specified these settings will override the settings cloned \r\n from source web app. If not specified, application settings from source web app are retained.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "configureLoadBalancing": { + "description": "If specified configure load balancing for source and clone site", + "type": "boolean" + }, + "trafficManagerProfileId": { + "description": "ARM resource id of the traffic manager profile to use if it exists. Traffic manager resource id is of the form \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}", + "type": "string" + }, + "trafficManagerProfileName": { + "description": "Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist", + "type": "string" + } + } + }, + "NameValuePair": { + "description": "Name value pair", + "type": "object", + "properties": { + "name": { + "description": "Pair name", + "type": "string" + }, + "value": { + "description": "Pair value", + "type": "string" + } + } + }, + "ConnStringInfo": { + "description": "Represents database connection string information", + "required": [ + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of connection string", + "type": "string" + }, + "connectionString": { + "description": "Connection string value", + "type": "string" + }, + "type": { + "description": "Type of database", + "enum": [ + "MySql", + "SQLServer", + "SQLAzure", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseServerType", + "modelAsString": false + } + } + } + }, + "HandlerMapping": { + "description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \r\n For example it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.", + "type": "object", + "properties": { + "extension": { + "description": "Requests with this extension will be handled using the specified FastCGI application.", + "type": "string" + }, + "scriptProcessor": { + "description": "The absolute path to the FastCGI application.", + "type": "string" + }, + "arguments": { + "description": "Command-line arguments to be passed to the script processor.", + "type": "string" + } + } + }, + "VirtualApplication": { + "type": "object", + "properties": { + "virtualPath": { + "type": "string" + }, + "physicalPath": { + "type": "string" + }, + "preloadEnabled": { + "type": "boolean" + }, + "virtualDirectories": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualDirectory" + } + } + } + }, + "RoutingRule": { + "description": "Routing rules for TiP", + "type": "object", + "properties": { + "name": { + "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.", + "type": "string" + } + } + }, + "Experiments": { + "description": "Class containing Routing in production experiments", + "type": "object", + "properties": { + "rampUpRules": { + "description": "List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects.", + "type": "array", + "items": { + "$ref": "#/definitions/RampUpRule" + } + } + } + }, + "SiteLimits": { + "description": "Represents metric limits set on a web app.", + "type": "object", + "properties": { + "maxPercentageCpu": { + "format": "double", + "description": "Maximum allowed CPU usage percentage", + "type": "number" + }, + "maxMemoryInMb": { + "format": "int64", + "description": "Maximum allowed memory usage in MB", + "type": "integer" + }, + "maxDiskSizeInMb": { + "format": "int64", + "description": "Maximum allowed disk size usage in MB", + "type": "integer" + } + } + }, + "AutoHealRules": { + "description": "AutoHealRules - describes the rules which can be defined for auto-heal", + "type": "object", + "properties": { + "triggers": { + "$ref": "#/definitions/AutoHealTriggers", + "description": "Triggers - Conditions that describe when to execute the auto-heal actions" + }, + "actions": { + "$ref": "#/definitions/AutoHealActions", + "description": "Actions - Actions to be executed when a rule is triggered" + } + } + }, + "SiteAuthSettings": { + "description": "Configuration settings for the Azure App Service Authentication / Authorization feature.", + "type": "object", + "properties": { + "enabled": { + "description": "Gets or sets a value indicating whether the Authentication / Authorization feature is enabled for the current app.", + "type": "boolean" + }, + "httpApiPrefixPath": { + "description": "Gets or sets the relative path prefix used by platform HTTP APIs.\r\n Changing this value is not recommended except for compatibility reasons.", + "type": "string" + }, + "unauthenticatedClientAction": { + "description": "Gets or sets the action to take when an unauthenticated client attempts to access the app.", + "enum": [ + "RedirectToLoginPage", + "AllowAnonymous" + ], + "type": "string", + "x-ms-enum": { + "name": "UnauthenticatedClientAction", + "modelAsString": false + } + }, + "tokenStoreEnabled": { + "description": "Gets or sets a value indicating whether to durably store platform-specific security tokens\r\n obtained during login flows. This capability is disabled by default.", + "type": "boolean" + }, + "allowedExternalRedirectUrls": { + "description": "Gets or sets a collection of external URLs that can be redirected to as part of logging in\r\n or logging out of the web app. Note that the query string part of the URL is ignored.\r\n This is an advanced setting typically only needed by Windows Store application backends.\r\n Note that URLs within the current domain are always implicitly allowed.", + "type": "array", + "items": { + "type": "string" + } + }, + "defaultProvider": { + "description": "Gets or sets the default authentication provider to use when multiple providers are configured.\r\n This setting is only needed if multiple providers are configured and the unauthenticated client\r\n action is set to \"RedirectToLoginPage\".", + "enum": [ + "AzureActiveDirectory", + "Facebook", + "Google", + "MicrosoftAccount", + "Twitter" + ], + "type": "string", + "x-ms-enum": { + "name": "BuiltInAuthenticationProvider", + "modelAsString": false + } + }, + "clientId": { + "description": "Gets or sets the Client ID of this relying party application, known as the client_id.\r\n This setting is required for enabling OpenID Connection authentication with Azure Active Directory or \r\n other 3rd party OpenID Connect providers.\r\n More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", + "type": "string" + }, + "clientSecret": { + "description": "Gets or sets the Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\r\n This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\r\n Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\r\n More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", + "type": "string" + }, + "issuer": { + "description": "Gets or sets the OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\r\n When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\r\n This URI is a case-sensitive identifier for the token issuer.\r\n More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html", + "type": "string" + }, + "allowedAudiences": { + "description": "Gets or sets a list of allowed audience values to consider when validating JWTs issued by \r\n Azure Active Directory. Note that the {Microsoft.Web.Hosting.Administration.SiteAuthSettings.ClientId} value is always considered an\r\n allowed audience, regardless of this setting.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalLoginParams": { + "description": "Gets or sets a list of login parameters to send to the OpenID Connect authorization endpoint when\r\n a user logs in. Each parameter must be in the form \"key=value\".", + "type": "array", + "items": { + "type": "string" + } + }, + "aadClientId": { + "type": "string" + }, + "openIdIssuer": { + "type": "string" + }, + "googleClientId": { + "description": "Gets or sets the OpenID Connect Client ID for the Google web application.\r\n This setting is required for enabling Google Sign-In.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/", + "type": "string" + }, + "googleClientSecret": { + "description": "Gets or sets the client secret associated with the Google web application.\r\n This setting is required for enabling Google Sign-In.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/", + "type": "string" + }, + "googleOAuthScopes": { + "description": "Gets or sets the OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\r\n This setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\r\n Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/", + "type": "array", + "items": { + "type": "string" + } + }, + "facebookAppId": { + "description": "Gets or sets the App ID of the Facebook app used for login.\r\n This setting is required for enabling Facebook Login.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login", + "type": "string" + }, + "facebookAppSecret": { + "description": "Gets or sets the App Secret of the Facebook app used for Facebook Login.\r\n This setting is required for enabling Facebook Login.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login", + "type": "string" + }, + "facebookOAuthScopes": { + "description": "Gets or sets the OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\r\n This setting is optional.\r\n Facebook Login documentation: https://developers.facebook.com/docs/facebook-login", + "type": "array", + "items": { + "type": "string" + } + }, + "twitterConsumerKey": { + "description": "Gets or sets the OAuth 1.0a consumer key of the Twitter application used for sign-in.\r\n This setting is required for enabling Twitter Sign-In.\r\n Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in", + "type": "string" + }, + "twitterConsumerSecret": { + "description": "Gets or sets the OAuth 1.0a consumer secret of the Twitter application used for sign-in.\r\n This setting is required for enabling Twitter Sign-In.\r\n Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in", + "type": "string" + }, + "microsoftAccountClientId": { + "description": "Gets or sets the OAuth 2.0 client ID that was created for the app used for authentication.\r\n This setting is required for enabling Microsoft Account authentication.\r\n Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm", + "type": "string" + }, + "microsoftAccountClientSecret": { + "description": "Gets or sets the OAuth 2.0 client secret that was created for the app used for authentication.\r\n This setting is required for enabling Microsoft Account authentication.\r\n Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm", + "type": "string" + }, + "microsoftAccountOAuthScopes": { + "description": "Gets or sets the OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\r\n This setting is optional. If not specified, \"wl.basic\" is used as the default scope.\r\n Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "CorsSettings": { + "description": "Cross-Origin Resource Sharing (CORS) settings for the web app.", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Gets or sets the list of origins that should be allowed to make cross-origin\r\n calls (for example: http://example.com:12345). Use \"*\" to allow all.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ApiDefinitionInfo": { + "description": "Information about the formal API definition for the web app.", + "type": "object", + "properties": { + "url": { + "description": "The URL of the API definition.", + "type": "string" + } + } + }, + "IpSecurityRestriction": { + "description": "Represents an ip security restriction on a web app.", + "type": "object", + "properties": { + "ipAddress": { + "description": "IP address the security restriction is valid for", + "type": "string" + }, + "subnetMask": { + "description": "Subnet mask for the range of IP addresses the restriction is valid for", + "type": "string" + } + } + }, + "VirtualDirectory": { + "type": "object", + "properties": { + "virtualPath": { + "type": "string" + }, + "physicalPath": { + "type": "string" + } + } + }, + "RampUpRule": { + "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance", + "type": "object", + "properties": { + "actionHostName": { + "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net", + "type": "string" + }, + "reroutePercentage": { + "format": "double", + "description": "Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName}", + "type": "number" + }, + "changeStep": { + "format": "double", + "description": "[Optional] In auto ramp up scenario this is the step to to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches \r\n {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specificed in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}.\r\n Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}", + "type": "number" + }, + "changeIntervalInMinutes": { + "format": "int32", + "description": "[Optional] Specifies interval in mimuntes to reevaluate ReroutePercentage", + "type": "integer" + }, + "minReroutePercentage": { + "format": "double", + "description": "[Optional] Specifies lower boundary above which ReroutePercentage will stay.", + "type": "number" + }, + "maxReroutePercentage": { + "format": "double", + "description": "[Optional] Specifies upper boundary below which ReroutePercentage will stay.", + "type": "number" + }, + "changeDecisionCallbackUrl": { + "description": "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n https://www.siteextensions.net/packages/TiPCallback/", + "type": "string" + }, + "name": { + "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.", + "type": "string" + } + } + }, + "AutoHealTriggers": { + "description": "AutoHealTriggers - describes the triggers for auto-heal.", + "type": "object", + "properties": { + "requests": { + "$ref": "#/definitions/RequestsBasedTrigger", + "description": "Requests - Defines a rule based on total requests" + }, + "privateBytesInKB": { + "format": "int32", + "description": "PrivateBytesInKB - Defines a rule based on private bytes", + "type": "integer" + }, + "statusCodes": { + "description": "StatusCodes - Defines a rule based on status codes", + "type": "array", + "items": { + "$ref": "#/definitions/StatusCodesBasedTrigger" + } + }, + "slowRequests": { + "$ref": "#/definitions/SlowRequestsBasedTrigger", + "description": "SlowRequests - Defines a rule based on request execution time" + } + } + }, + "AutoHealActions": { + "description": "AutoHealActions - Describes the actions which can be\r\n taken by the auto-heal module when a rule is triggered.", + "required": [ + "actionType" + ], + "type": "object", + "properties": { + "actionType": { + "description": "ActionType - predefined action to be taken", + "enum": [ + "Recycle", + "LogEvent", + "CustomAction" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoHealActionType", + "modelAsString": false + } + }, + "customAction": { + "$ref": "#/definitions/AutoHealCustomAction", + "description": "CustomAction - custom action to be taken" + }, + "minProcessExecutionTime": { + "description": "MinProcessExecutionTime - minimum time the process must execute\r\n before taking the action", + "type": "string" + } + } + }, + "RequestsBasedTrigger": { + "description": "RequestsBasedTrigger", + "type": "object", + "properties": { + "count": { + "format": "int32", + "description": "Count", + "type": "integer" + }, + "timeInterval": { + "description": "TimeInterval", + "type": "string" + } + } + }, + "StatusCodesBasedTrigger": { + "description": "StatusCodeBasedTrigger", + "type": "object", + "properties": { + "status": { + "format": "int32", + "description": "HTTP status code", + "type": "integer" + }, + "subStatus": { + "format": "int32", + "description": "SubStatus", + "type": "integer" + }, + "win32Status": { + "format": "int32", + "description": "Win32 error code", + "type": "integer" + }, + "count": { + "format": "int32", + "description": "Count", + "type": "integer" + }, + "timeInterval": { + "description": "TimeInterval", + "type": "string" + } + } + }, + "SlowRequestsBasedTrigger": { + "description": "SlowRequestsBasedTrigger", + "type": "object", + "properties": { + "timeTaken": { + "description": "TimeTaken", + "type": "string" + }, + "count": { + "format": "int32", + "description": "Count", + "type": "integer" + }, + "timeInterval": { + "description": "TimeInterval", + "type": "string" + } + } + }, + "AutoHealCustomAction": { + "description": "AutoHealCustomAction - Describes the custom action to be executed\r\n when an auto heal rule is triggered.", + "type": "object", + "properties": { + "exe": { + "description": "Executable to be run", + "type": "string" + }, + "parameters": { + "description": "Parameters for the executable", + "type": "string" + } + } + }, + "HostingEnvironmentCollection": { + "description": "Collection of hosting environments (App Service Environments)", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/HostingEnvironment" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "HostingEnvironment": { + "description": "Description of an hostingEnvironment (App Service Environment)", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "required": [ + "status" + ], + "properties": { + "name": { + "description": "Name of the hostingEnvironment (App Service Environment)", + "type": "string" + }, + "location": { + "description": "Location of the hostingEnvironment (App Service Environment), e.g. \"West US\"", + "type": "string" + }, + "status": { + "description": "Current status of the hostingEnvironment (App Service Environment)", + "enum": [ + "Preparing", + "Ready", + "Scaling", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "HostingEnvironmentStatus", + "modelAsString": false + } + }, + "vnetName": { + "description": "Name of the hostingEnvironment's (App Service Environment) virtual network", + "type": "string" + }, + "vnetResourceGroupName": { + "description": "Resource group of the hostingEnvironment's (App Service Environment) virtual network", + "type": "string" + }, + "vnetSubnetName": { + "description": "Subnet of the hostingEnvironment's (App Service Environment) virtual network", + "type": "string" + }, + "virtualNetwork": { + "$ref": "#/definitions/VirtualNetworkProfile", + "description": "Description of the hostingEnvironment's (App Service Environment) virtual network" + }, + "internalLoadBalancingMode": { + "description": "Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET", + "enum": [ + "None", + "Web", + "Publishing" + ], + "type": "string", + "x-ms-enum": { + "name": "InternalLoadBalancingMode", + "modelAsString": false + } + }, + "multiSize": { + "description": "Front-end VM size, e.g. \"Medium\", \"Large\"", + "type": "string" + }, + "multiRoleCount": { + "format": "int32", + "description": "Number of front-end instances", + "type": "integer" + }, + "workerPools": { + "description": "Description of worker pools with worker size ids, VM sizes, and number of workers in each pool", + "type": "array", + "items": { + "$ref": "#/definitions/WorkerPool" + } + }, + "ipsslAddressCount": { + "format": "int32", + "description": "Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment)", + "type": "integer" + }, + "databaseEdition": { + "description": "Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. \"Standard\"", + "type": "string" + }, + "databaseServiceObjective": { + "description": "Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. \"S0\"", + "type": "string" + }, + "upgradeDomains": { + "format": "int32", + "description": "Number of upgrade domains of this hostingEnvironment (App Service Environment)", + "type": "integer" + }, + "subscriptionId": { + "description": "Subscription of the hostingEnvironment (App Service Environment)", + "type": "string" + }, + "dnsSuffix": { + "description": "DNS suffix of the hostingEnvironment (App Service Environment)", + "type": "string" + }, + "lastAction": { + "description": "Last deployment action on this hostingEnvironment (App Service Environment)", + "type": "string" + }, + "lastActionResult": { + "description": "Result of the last deployment action on this hostingEnvironment (App Service Environment)", + "type": "string" + }, + "allowedMultiSizes": { + "description": "List of comma separated strings describing which VM sizes are allowed for front-ends", + "type": "string" + }, + "allowedWorkerSizes": { + "description": "List of comma separated strings describing which VM sizes are allowed for workers", + "type": "string" + }, + "maximumNumberOfMachines": { + "format": "int32", + "description": "Maximum number of VMs in this hostingEnvironment (App Service Environment)", + "type": "integer" + }, + "vipMappings": { + "description": "Description of IP SSL mapping for this hostingEnvironment (App Service Environment)", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualIPMapping" + } + }, + "environmentCapacities": { + "description": "Current total, used, and available worker capacities", + "type": "array", + "items": { + "$ref": "#/definitions/StampCapacity" + } + }, + "networkAccessControlList": { + "description": "Access control list for controlling traffic to the hostingEnvironment (App Service Environment)", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAccessControlEntry" + } + }, + "environmentIsHealthy": { + "description": "True/false indicating whether the hostingEnvironment (App Service Environment) is healthy", + "type": "boolean" + }, + "environmentStatus": { + "description": "Detailed message about with results of the last check of the hostingEnvironment (App Service Environment)", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group of the hostingEnvironment (App Service Environment)", + "type": "string" + }, + "apiManagementAccountId": { + "description": "Api Management Account associated with this Hosting Environment", + "type": "string" + }, + "suspended": { + "description": "True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\r\n (most likely because NSG blocked the incoming traffic)", + "type": "boolean" + }, + "clusterSettings": { + "description": "Custom settings for changing the behavior of the hosting environment", + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkProfile": { + "description": "Specification for using a virtual network", + "type": "object", + "properties": { + "id": { + "description": "Resource id of the virtual network", + "type": "string" + }, + "name": { + "description": "Name of the virtual network (read-only)", + "type": "string" + }, + "type": { + "description": "Resource type of the virtual network (read-only)", + "type": "string" + }, + "subnet": { + "description": "Subnet within the virtual network", + "type": "string" + } + } + }, + "WorkerPool": { + "description": "Worker pool of a hostingEnvironment (App Service Environment)", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "workerSizeId": { + "format": "int32", + "description": "Worker size id for referencing this worker pool", + "type": "integer" + }, + "computeMode": { + "description": "Shared or dedicated web app hosting", + "enum": [ + "Shared", + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeModeOptions", + "modelAsString": false + } + }, + "workerSize": { + "description": "VM size of the worker pool instances", + "type": "string" + }, + "workerCount": { + "format": "int32", + "description": "Number of instances in the worker pool", + "type": "integer" + }, + "instanceNames": { + "description": "Names of all instances in the worker pool (read only)", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/SkuDescription" + } + } + }, + "VirtualIPMapping": { + "description": "Class that represents a VIP mapping", + "type": "object", + "properties": { + "virtualIP": { + "description": "Virtual IP address", + "type": "string" + }, + "internalHttpPort": { + "format": "int32", + "description": "Internal HTTP port", + "type": "integer" + }, + "internalHttpsPort": { + "format": "int32", + "description": "Internal HTTPS port", + "type": "integer" + }, + "inUse": { + "description": "Is VIP mapping in use", + "type": "boolean" + } + } + }, + "StampCapacity": { + "description": "Class containing stamp capacity information", + "type": "object", + "properties": { + "name": { + "description": "Name of the stamp", + "type": "string" + }, + "availableCapacity": { + "format": "int64", + "description": "Available capacity (# of machines, bytes of storage etc...)", + "type": "integer" + }, + "totalCapacity": { + "format": "int64", + "description": "Total capacity (# of machines, bytes of storage etc...)", + "type": "integer" + }, + "unit": { + "description": "Name of the unit", + "type": "string" + }, + "computeMode": { + "description": "Shared/Dedicated workers", + "enum": [ + "Shared", + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeModeOptions", + "modelAsString": false + } + }, + "workerSize": { + "description": "Size of the machines", + "enum": [ + "Default", + "Small", + "Medium", + "Large" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkerSizeOptions", + "modelAsString": false + } + }, + "workerSizeId": { + "format": "int32", + "description": "Size Id of machines: \r\n 0 - Small\r\n 1 - Medium\r\n 2 - Large", + "type": "integer" + }, + "excludeFromCapacityAllocation": { + "description": "If true it includes basic sites\r\n Basic sites are not used for capacity allocation.", + "type": "boolean" + }, + "isApplicableForAllComputeModes": { + "description": "Is capacity applicable for all sites?", + "type": "boolean" + }, + "siteMode": { + "description": "Shared or Dedicated", + "type": "string" + } + } + }, + "NetworkAccessControlEntry": { + "type": "object", + "properties": { + "action": { + "enum": [ + "Permit", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessControlEntryAction", + "modelAsString": false + } + }, + "description": { + "type": "string" + }, + "order": { + "format": "int32", + "type": "integer" + }, + "remoteSubnet": { + "type": "string" + } + } + }, + "ManagedHostingEnvironmentCollection": { + "description": "Collection of managed hosting environments", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedHostingEnvironment" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "ManagedHostingEnvironment": { + "description": "Description of a managed hosting environment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "required": [ + "status" + ], + "properties": { + "name": { + "description": "Name of the managed hosting environment", + "type": "string" + }, + "location": { + "description": "Location of the managed hosting environment e.g. \"West US\"", + "type": "string" + }, + "status": { + "description": "Current status of the managed hosting environment", + "enum": [ + "Preparing", + "Ready", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedHostingEnvironmentStatus", + "modelAsString": false + } + }, + "virtualNetwork": { + "$ref": "#/definitions/VirtualNetworkProfile", + "description": "Description of the managed hosting environment's virtual network" + }, + "ipsslAddressCount": { + "format": "int32", + "description": "Number of ip ssl addresses reserved for the managed hosting environment", + "type": "integer" + }, + "dnsSuffix": { + "description": "DNS suffix of the managed hosting environment", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription of the managed hosting environment (read only)", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group of the managed hosting environment (read only)", + "type": "string" + }, + "environmentIsHealthy": { + "description": "True/false indicating whether the managed hosting environment is healthy", + "type": "boolean" + }, + "environmentStatus": { + "description": "Detailed message about with results of the last check of the managed hosting environment", + "type": "string" + }, + "suspended": { + "description": "True/false indicating whether the managed hosting environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\r\n (most likely because NSG blocked the incoming traffic)", + "type": "boolean" + }, + "apiManagementAccount": { + "description": "Resource id of the api management account associated with this managed hosting environment (read only)", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content", + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify", + "type": "string" + }, + "type": { + "description": "Resource type used for verification", + "type": "string" + }, + "isFqdn": { + "description": "Is fully qualified domain name", + "type": "boolean" + } + } + }, + "ResourceNameAvailability": { + "description": "Describes if a resource name is available", + "type": "object", + "properties": { + "nameAvailable": { + "description": "True indicates name is valid and available. False indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "Required if nameAvailable is false. 'Invalid' indicates the name provided does not match Azure WebApp service’s naming requirements. 'AlreadyExists' indicates that the name is already in use and is therefore unavailable.", + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "DomainControlCenterSsoRequest": { + "description": "Single sign on request information for domain management", + "type": "object", + "properties": { + "url": { + "description": "Url where the single sign on request is to be made", + "type": "string" + }, + "postParameterKey": { + "description": "Post parameter key", + "type": "string" + }, + "postParameterValue": { + "description": "Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value.", + "type": "string" + } + } + }, + "DomainRegistrationInput": { + "description": "Domain registration input for validation Api", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Name of the domain", + "type": "string" + }, + "contactAdmin": { + "$ref": "#/definitions/Contact", + "description": "Admin contact information" + }, + "contactBilling": { + "$ref": "#/definitions/Contact", + "description": "Billing contact information" + }, + "contactRegistrant": { + "$ref": "#/definitions/Contact", + "description": "Registrant contact information" + }, + "contactTech": { + "$ref": "#/definitions/Contact", + "description": "Technical contact information" + }, + "registrationStatus": { + "description": "Domain registration status", + "enum": [ + "Active", + "Awaiting", + "Cancelled", + "Confiscated", + "Disabled", + "Excluded", + "Expired", + "Failed", + "Held", + "Locked", + "Parked", + "Pending", + "Reserved", + "Reverted", + "Suspended", + "Transferred", + "Unknown", + "Unlocked", + "Unparked", + "Updated", + "JsonConverterFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainStatus", + "modelAsString": false + } + }, + "provisioningState": { + "description": "Domain provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "nameServers": { + "description": "Name servers", + "type": "array", + "items": { + "type": "string" + } + }, + "privacy": { + "description": "If true then domain privacy is enabled for this domain", + "type": "boolean" + }, + "createdTime": { + "format": "date-time", + "description": "Domain creation timestamp", + "type": "string" + }, + "expirationTime": { + "format": "date-time", + "description": "Domain expiration timestamp", + "type": "string" + }, + "lastRenewedTime": { + "format": "date-time", + "description": "Timestamp when the domain was renewed last time", + "type": "string" + }, + "autoRenew": { + "description": "If true then domain will renewed automatically", + "type": "boolean" + }, + "readyForDnsRecordManagement": { + "description": "If true then Azure can assign this domain to Web Apps. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to", + "type": "boolean" + }, + "managedHostNames": { + "description": "All hostnames derived from the domain and assigned to Azure resources", + "type": "array", + "items": { + "$ref": "#/definitions/HostName" + } + }, + "consent": { + "$ref": "#/definitions/DomainPurchaseConsent", + "description": "Legal agreement consent" + } + }, + "x-ms-client-flatten": true + } + } + }, + "NameIdentifier": { + "description": "Identifies an object", + "type": "object", + "properties": { + "name": { + "description": "Name of the object", + "type": "string" + } + } + }, + "DomainAvailablilityCheckResult": { + "description": "Domain availablility check result", + "type": "object", + "properties": { + "name": { + "description": "Name of the domain", + "type": "string" + }, + "available": { + "description": "If true then domain can be purchased using CreateDomain Api", + "type": "boolean" + }, + "domainType": { + "description": "Domain type", + "enum": [ + "Regular", + "SoftDeleted" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainType", + "modelAsString": false + } + } + } + }, + "DomainRecommendationSearchParameters": { + "description": "Domain recommendation search parameters", + "type": "object", + "properties": { + "keywords": { + "description": "Keywords to be used for generating domain recommendations", + "type": "string" + }, + "maxDomainRecommendations": { + "format": "int32", + "description": "Maximum number of recommendations", + "type": "integer" + } + } + }, + "NameIdentifierCollection": { + "description": "Collection of domain name identifiers", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/NameIdentifier" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "CsmMoveResourceEnvelope": { + "description": "Class containing a list of the resources that need to be moved and the resource group they should be moved to", + "type": "object", + "properties": { + "targetResourceGroup": { + "type": "string" + }, + "resources": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HostingEnvironmentDiagnostics": { + "description": "Diagnostics for a hosting environment (App Service Environment)", + "type": "object", + "properties": { + "name": { + "description": "Name/identifier of the diagnostics", + "type": "string" + }, + "diagnosicsOutput": { + "description": "Diagnostics output", + "type": "string" + } + } + }, + "StampCapacityCollection": { + "description": "Collection of stamp capacities", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/StampCapacity" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "AddressResponse": { + "description": "Describes main public ip address and any extra vips", + "type": "object", + "properties": { + "serviceIpAddress": { + "description": "Main public vip", + "type": "string" + }, + "internalIpAddress": { + "description": "VNET internal ip address of the hostingEnvironment (App Service Environment) if it is in internal load-balancing mode", + "type": "string" + }, + "outboundIpAddresses": { + "description": "IP addresses appearing on outbound connections", + "type": "array", + "items": { + "type": "string" + } + }, + "vipMappings": { + "description": "Additional vips", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualIPMapping" + } + } + } + }, + "ResourceMetricCollection": { + "description": "Collection of metric responses", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceMetric" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "ResourceMetric": { + "description": "Object representing a metric for any resource", + "type": "object", + "properties": { + "name": { + "$ref": "#/definitions/ResourceMetricName", + "description": "Name of metric" + }, + "unit": { + "description": "Metric unit", + "type": "string" + }, + "timeGrain": { + "description": "Metric granularity. E.g PT1H, PT5M, P1D", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Metric start time", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Metric end time", + "type": "string" + }, + "resourceId": { + "description": "Metric resource Id", + "type": "string" + }, + "metricValues": { + "description": "Metric values", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceMetricValue" + } + }, + "properties": { + "description": "Properties", + "type": "array", + "items": { + "$ref": "#/definitions/KeyValuePair[String,String]" + } + } + } + }, + "ResourceMetricName": { + "description": "Name of a metric for any resource", + "type": "object", + "properties": { + "value": { + "description": "metric name value", + "type": "string" + }, + "localizedValue": { + "description": "Localized metric name value", + "type": "string" + } + } + }, + "ResourceMetricValue": { + "description": "Value of resource metric", + "type": "object", + "properties": { + "timeStamp": { + "description": "Value timestamp", + "type": "string" + }, + "average": { + "format": "float", + "description": "Value average", + "type": "number" + }, + "minimum": { + "format": "float", + "description": "Value minimum", + "type": "number" + }, + "maximum": { + "format": "float", + "description": "Value maximum", + "type": "number" + }, + "total": { + "format": "float", + "description": "Value total", + "type": "number" + }, + "count": { + "format": "float", + "description": "Value count", + "type": "number" + } + } + }, + "KeyValuePair[String,String]": { + "type": "object", + "properties": { + "key": { + "type": "string", + "readOnly": true + }, + "value": { + "type": "string", + "readOnly": true + } + } + }, + "MetricDefinition": { + "description": "Class repesenting metadata for the metrics", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Name of the metric", + "type": "string" + }, + "unit": { + "description": "Unit of the metric", + "type": "string" + }, + "primaryAggregationType": { + "description": "Primary aggregation type", + "type": "string" + }, + "metricAvailabilities": { + "description": "List of time grains supported for the metric together with retention period", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailabilily" + } + }, + "displayName": { + "description": "Friendly name shown in the UI", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "MetricAvailabilily": { + "description": "Class repesenting metrics availability and retention", + "type": "object", + "properties": { + "timeGrain": { + "description": "Time grain", + "type": "string" + }, + "retention": { + "description": "Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain}", + "type": "string" + } + } + }, + "CsmUsageQuotaCollection": { + "description": "Collection of csm usage quotas", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/CsmUsageQuota" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "CsmUsageQuota": { + "description": "Usage of the quota resource", + "type": "object", + "properties": { + "unit": { + "description": "Units of measurement for the quota resourse", + "type": "string" + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time for the resource counter", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "The current value of the resource counter", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The resource limit", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "Quota name" + } + } + }, + "LocalizableString": { + "description": "LocalizableString object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "Non localized name", + "type": "string" + }, + "localizedValue": { + "description": "Localized name", + "type": "string" + } + } + }, + "MetricDefinitionCollection": { + "description": "Collection of metric defintions", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/MetricDefinition" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "UsageCollection": { + "description": "Collection of usages", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "Usage": { + "description": "Class that represents usage of the quota resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "displayName": { + "description": "Friendly name shown in the UI", + "type": "string" + }, + "name": { + "description": "Name of the quota", + "type": "string" + }, + "resourceName": { + "description": "Name of the quota resource", + "type": "string" + }, + "unit": { + "description": "Units of measurement for the quota resource", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "The current value of the resource counter", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The resource limit", + "type": "integer" + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time for the resource counter", + "type": "string" + }, + "computeMode": { + "description": "ComputeMode used for this usage", + "enum": [ + "Shared", + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "ComputeModeOptions", + "modelAsString": false + } + }, + "siteMode": { + "description": "SiteMode used for this usage", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "WorkerPoolCollection": { + "description": "Collection of worker pools", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/WorkerPool" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "SkuInfoCollection": { + "description": "Collection of SkuInfos", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/SkuInfo" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "SkuInfo": { + "description": "Sku discovery information", + "type": "object", + "properties": { + "resourceType": { + "description": "Resource type that this sku applies to", + "type": "string" + }, + "sku": { + "$ref": "#/definitions/SkuDescription", + "description": "Name and tier of the sku" + }, + "capacity": { + "$ref": "#/definitions/SkuCapacity", + "description": "Min, max, and default scale values of the sku" + } + } + }, + "SkuCapacity": { + "description": "Description of the App Service Plan scale options", + "type": "object", + "properties": { + "minimum": { + "format": "int32", + "description": "Minimum number of Workers for this App Service Plan SKU", + "type": "integer" + }, + "maximum": { + "format": "int32", + "description": "Maximum number of Workers for this App Service Plan SKU", + "type": "integer" + }, + "default": { + "format": "int32", + "description": "Default number of Workers for this App Service Plan SKU", + "type": "integer" + }, + "scaleType": { + "description": "Available scale configurations for an App Service Plan", + "type": "string" + } + } + }, + "SourceControlCollection": { + "description": "Collection of soure controls", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/SourceControl" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "SourceControl": { + "description": "Describes the Source Control OAuth Token", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Name or Source Control Type", + "type": "string" + }, + "token": { + "description": "OAuth Access Token", + "type": "string" + }, + "tokenSecret": { + "description": "OAuth Access Token Secret", + "type": "string" + }, + "refreshToken": { + "description": "OAuth Refresh Token", + "type": "string" + }, + "expirationTime": { + "format": "date-time", + "description": "OAuth Token Expiration", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "Recommendation": { + "description": "Represents a recommendation result generated by the recommendation engine", + "required": [ + "level", + "channels", + "category" + ], + "type": "object", + "properties": { + "creationTime": { + "format": "date-time", + "description": "Timestamp when this instance was created.", + "type": "string" + }, + "recommendationId": { + "description": "A GUID value that each recommendation object is associated with.", + "type": "string" + }, + "resourceId": { + "description": "Full ARM resource ID string that this recommendation object is associated with.", + "type": "string" + }, + "resourceScope": { + "description": "Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.", + "type": "string" + }, + "ruleName": { + "description": "Unique name of the rule", + "type": "string" + }, + "displayName": { + "description": "UI friendly name of the rule (may not be unique)", + "type": "string" + }, + "message": { + "description": "Localized text of recommendation, good for UI.", + "type": "string" + }, + "level": { + "description": "Level indicating how critical this recommendation can impact.", + "enum": [ + "Critical", + "Warning", + "Information", + "NonUrgentSuggestion" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationLevel", + "modelAsString": false + } + }, + "channels": { + "description": "List of channels that this recommendation can apply.", + "enum": [ + "Notification", + "Api", + "Email", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "Channels", + "modelAsString": false + } + }, + "category": { + "description": "The category that this recommendation belongs to.", + "enum": [ + "Uncategorized", + "Test", + "UpSell", + "CrossSell", + "LiveSite" + ], + "type": "string", + "x-ms-enum": { + "name": "Category", + "modelAsString": false + } + }, + "actionName": { + "description": "Name of action recommended by this object.", + "type": "string" + }, + "enabled": { + "format": "int32", + "description": "On/off flag indicating the rule is currently enabled or disabled.", + "type": "integer" + }, + "startTime": { + "format": "date-time", + "description": "The beginning time of a range that the recommendation refers to.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time of a range that the recommendation refers to.", + "type": "string" + }, + "nextNotificationTime": { + "format": "date-time", + "description": "When to notify this recommendation next. Null means that this will never be notified anymore.", + "type": "string" + }, + "notificationExpirationTime": { + "format": "date-time", + "description": "Date and time when this notification expires.", + "type": "string" + }, + "notifiedTime": { + "format": "date-time", + "description": "Last timestamp this instance was actually notified. Null means that this recommendation hasn't been notified yet.", + "type": "string" + }, + "score": { + "format": "double", + "description": "A metric value measured by the rule.", + "type": "number" + } + } + }, + "RecommendationRule": { + "description": "Represents a recommendation rule that the recommendation engine can perform", + "required": [ + "level", + "channels", + "category" + ], + "type": "object", + "properties": { + "name": { + "description": "Unique name of the rule", + "type": "string" + }, + "displayName": { + "description": "UI friendly name of the rule", + "type": "string" + }, + "message": { + "description": "Localized name of the rule (Good for UI)", + "type": "string" + }, + "recommendationId": { + "description": "Recommendation ID of an associated recommendation object tied to the rule, if exists.\r\n If such an object doesn't exist, it is set to null.", + "type": "string" + }, + "description": { + "description": "Localized detailed description of the rule", + "type": "string" + }, + "actionName": { + "description": "Name of action that is recommended by this rule in string", + "type": "string" + }, + "enabled": { + "format": "int32", + "description": "On/off flag indicating the rule is currently enabled or disabled.", + "type": "integer" + }, + "level": { + "description": "Level of impact indicating how critical this rule is.", + "enum": [ + "Critical", + "Warning", + "Information", + "NonUrgentSuggestion" + ], + "type": "string", + "x-ms-enum": { + "name": "NotificationLevel", + "modelAsString": false + } + }, + "channels": { + "description": "List of available channels that this rule applies.", + "enum": [ + "Notification", + "Api", + "Email", + "All" + ], + "type": "string", + "x-ms-enum": { + "name": "Channels", + "modelAsString": false + } + }, + "category": { + "description": "The category that the rule belongs to.", + "enum": [ + "Uncategorized", + "Test", + "UpSell", + "CrossSell", + "LiveSite" + ], + "type": "string", + "x-ms-enum": { + "name": "Category", + "modelAsString": false + } + } + } + }, + "VnetInfo": { + "description": "VNETInfo contract. This contract is public and is a stripped down version of VNETInfoInternal", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "vnetResourceId": { + "description": "The vnet resource id", + "type": "string" + }, + "certThumbprint": { + "description": "The client certificate thumbprint", + "type": "string" + }, + "certBlob": { + "description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \r\n Point-To-Site VPN connection.", + "type": "string" + }, + "routes": { + "description": "The routes that this virtual network connection uses.", + "type": "array", + "items": { + "$ref": "#/definitions/VnetRoute" + } + }, + "resyncRequired": { + "description": "Flag to determine if a resync is required", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "VnetRoute": { + "description": "VnetRoute contract used to pass routing information for a vnet.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "The name of this route. This is only returned by the server and does not need to be set by the client.", + "type": "string" + }, + "startAddress": { + "description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.", + "type": "string" + }, + "endAddress": { + "description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.", + "type": "string" + }, + "routeType": { + "description": "The type of route this is:\r\n DEFAULT - By default, every web app has routes to the local address ranges specified by RFC1918\r\n INHERITED - Routes inherited from the real Virtual Network routes\r\n STATIC - Static route set on the web app only\r\n \r\n These values will be used for syncing a Web App's routes with those from a Virtual Network. This operation will clear all DEFAULT and INHERITED routes and replace them\r\n with new INHERITED routes.", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "VnetGateway": { + "description": "The VnetGateway contract. This is used to give the vnet gateway access to the VPN package.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "vnetName": { + "description": "The VNET name.", + "type": "string" + }, + "vpnPackageUri": { + "description": "The URI where the Vpn package can be downloaded", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "NetworkFeatures": { + "description": "This is an object used to store a full view of network features (presently VNET integration and Hybrid Connections)\r\n for a web app.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "virtualNetworkName": { + "description": "The Vnet Name", + "type": "string" + }, + "virtualNetworkConnection": { + "$ref": "#/definitions/VnetInfo", + "description": "The Vnet Summary view" + }, + "hybridConnections": { + "description": "The Hybrid Connections Summary view", + "type": "array", + "items": { + "$ref": "#/definitions/RelayServiceConnectionEntity" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "RelayServiceConnectionEntity": { + "description": "Class that represents a Biztalk Hybrid Connection", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "entityName": { + "type": "string" + }, + "entityConnectionString": { + "type": "string" + }, + "resourceType": { + "type": "string" + }, + "resourceConnectionString": { + "type": "string" + }, + "hostname": { + "type": "string" + }, + "port": { + "format": "int32", + "type": "integer" + }, + "biztalkUri": { + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "CsmSlotEntity": { + "description": "Class containing deployment slot parameters", + "type": "object", + "properties": { + "targetSlot": { + "description": "Set the destination deployment slot during swap operation", + "type": "string" + }, + "preserveVnet": { + "description": "Get or set the flag indicating it should preserve VNet to the slot during swap", + "type": "boolean" + } + } + }, + "SlotDifferenceCollection": { + "description": "Collection of Slot Differences", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/SlotDifference" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "SlotDifference": { + "description": "An object describing the difference in setting values between two web app slots", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "type": { + "description": "Indicates the type of the difference: Information, Warning or Error.", + "type": "string" + }, + "settingType": { + "description": "The type of the settings: General, AppSetting or ConnectionString", + "type": "string" + }, + "diffRule": { + "description": "Rule that describes how to process the difference in settings during web app slot swap.", + "type": "string" + }, + "settingName": { + "description": "Name of the setting", + "type": "string" + }, + "valueInCurrentSlot": { + "description": "Value of the setting in the current web app slot", + "type": "string" + }, + "valueInTargetSlot": { + "description": "Value of the setting in the target web app slot", + "type": "string" + }, + "description": { + "description": "Description of the difference", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SlotConfigNamesResource": { + "description": "Slot Config names azure resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "connectionStringNames": { + "description": "List of connection string names", + "type": "array", + "items": { + "type": "string" + } + }, + "appSettingNames": { + "description": "List of application settings names", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "SlotConfigNames": { + "description": "Class containing names for connection strings and application settings to be marked as sticky to the slot \r\n and not moved during swap operation\r\n This is valid for all deployment slots under the site", + "type": "object", + "properties": { + "connectionStringNames": { + "description": "List of connection string names", + "type": "array", + "items": { + "type": "string" + } + }, + "appSettingNames": { + "description": "List of application settings names", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SiteCloneability": { + "description": "Represents whether or not a web app is cloneable", + "required": [ + "result" + ], + "type": "object", + "properties": { + "result": { + "description": "Name of web app", + "enum": [ + "Cloneable", + "PartiallyCloneable", + "NotCloneable" + ], + "type": "string", + "x-ms-enum": { + "name": "CloneAbilityResult", + "modelAsString": false + } + }, + "blockingFeatures": { + "description": "List of features enabled on web app that prevent cloning", + "type": "array", + "items": { + "$ref": "#/definitions/SiteCloneabilityCriterion" + } + }, + "unsupportedFeatures": { + "description": "List of features enabled on web app that are non-blocking but cannot be cloned. The web app can still be cloned\r\n but the features in this list will not be set up on cloned web app.", + "type": "array", + "items": { + "$ref": "#/definitions/SiteCloneabilityCriterion" + } + }, + "blockingCharacteristics": { + "description": "List of blocking application characteristics", + "type": "array", + "items": { + "$ref": "#/definitions/SiteCloneabilityCriterion" + } + } + } + }, + "SiteCloneabilityCriterion": { + "description": "Represents a site cloneability criterion", + "type": "object", + "properties": { + "name": { + "description": "Name of criterion", + "type": "string" + }, + "description": { + "description": "Description of criterion", + "type": "string" + } + } + }, + "CsmSiteRecoveryEntity": { + "description": "Class containting details about site recovery operation.", + "type": "object", + "properties": { + "snapshotTime": { + "format": "date-time", + "description": "Point in time in which the site recover should be attempted.", + "type": "string" + }, + "siteName": { + "description": "[Optional] Destination web app name into which web app should be recovered. This is case when new web app should be created instead.", + "type": "string" + }, + "slotName": { + "description": "[Optional] Destination web app slot name into which web app should be recovered", + "type": "string" + } + } + }, + "DeletedSiteCollection": { + "description": "Collection of deleted sites", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/DeletedSite" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "DeletedSite": { + "description": "Reports deleted site including the timestamp of operation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "required": [ + "usageState", + "availabilityState" + ], + "properties": { + "deletedTimestamp": { + "format": "date-time", + "description": "Time when the site was deleted", + "type": "string" + }, + "name": { + "description": "Name of web app", + "type": "string" + }, + "state": { + "description": "State of the web app", + "type": "string", + "readOnly": true + }, + "hostNames": { + "description": "Hostnames associated with web app", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "repositorySiteName": { + "description": "Name of repository site", + "type": "string", + "readOnly": true + }, + "usageState": { + "description": "State indicating whether web app has exceeded its quota usage", + "enum": [ + "Normal", + "Exceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UsageState", + "modelAsString": false + } + }, + "enabled": { + "description": "True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line).", + "type": "boolean" + }, + "enabledHostNames": { + "description": "Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled\r\n the app is not served on those hostnames", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "availabilityState": { + "description": "Management information availability state for the web app. Possible values are Normal or Limited. \r\n Normal means that the site is running correctly and that management information for the site is available. \r\n Limited means that only partial management information for the site is available and that detailed site information is unavailable.", + "enum": [ + "Normal", + "Limited", + "DisasterRecoveryMode" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SiteAvailabilityState", + "modelAsString": false + } + }, + "hostNameSslStates": { + "description": "Hostname SSL states are used to manage the SSL bindings for site's hostnames.", + "type": "array", + "items": { + "$ref": "#/definitions/HostNameSslState" + } + }, + "serverFarmId": { + "type": "string" + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "Last time web app was modified in UTC", + "type": "string", + "readOnly": true + }, + "siteConfig": { + "$ref": "#/definitions/SiteConfig", + "description": "Configuration of web app" + }, + "trafficManagerHostNames": { + "description": "Read-only list of Azure Traffic manager hostnames associated with web app", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "premiumAppDeployed": { + "description": "If set indicates whether web app is deployed as a premium app", + "type": "boolean", + "readOnly": true + }, + "scmSiteAlsoStopped": { + "description": "If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false.", + "type": "boolean" + }, + "targetSwapSlot": { + "description": "Read-only property that specifies which slot this app will swap into", + "type": "string", + "readOnly": true + }, + "hostingEnvironmentProfile": { + "$ref": "#/definitions/HostingEnvironmentProfile", + "description": "Specification for the hosting environment (App Service Environment) to use for the web app" + }, + "microService": { + "description": "", + "type": "string" + }, + "gatewaySiteName": { + "description": "Name of gateway app associated with web app", + "type": "string" + }, + "clientAffinityEnabled": { + "description": "Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app", + "type": "boolean" + }, + "clientCertEnabled": { + "description": "Specifies if the client certificate is enabled for the web app", + "type": "boolean" + }, + "hostNamesDisabled": { + "description": "Specifies if the public hostnames are disabled the web app.\r\n If set to true the app is only accessible via API Management process", + "type": "boolean" + }, + "outboundIpAddresses": { + "description": "List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.", + "type": "string", + "readOnly": true + }, + "containerSize": { + "format": "int32", + "description": "Size of a function container", + "type": "integer" + }, + "maxNumberOfWorkers": { + "format": "int32", + "description": "Maximum number of workers\r\n This only applies to function container", + "type": "integer" + }, + "cloningInfo": { + "$ref": "#/definitions/CloningInfo", + "description": "This is only valid for web app creation. If specified, web app is cloned from \r\n a source web app" + }, + "resourceGroup": { + "description": "Resource group web app belongs to", + "type": "string", + "readOnly": true + }, + "isDefaultContainer": { + "description": "Site is a default container", + "type": "boolean", + "readOnly": true + }, + "defaultHostName": { + "description": "Default hostname of the web app", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "DeploymentCollection": { + "description": "Collection of app deployments", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/Deployment" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "Deployment": { + "description": "Represents user crendentials used for publishing activity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "id": { + "description": "Id", + "type": "string" + }, + "status": { + "format": "int32", + "description": "Status", + "type": "integer" + }, + "message": { + "description": "Message", + "type": "string" + }, + "author": { + "description": "Author", + "type": "string" + }, + "deployer": { + "description": "Deployer", + "type": "string" + }, + "author_email": { + "description": "AuthorEmail", + "type": "string" + }, + "start_time": { + "format": "date-time", + "description": "StartTime", + "type": "string" + }, + "end_time": { + "format": "date-time", + "description": "EndTime", + "type": "string" + }, + "active": { + "description": "Active", + "type": "boolean" + }, + "details": { + "description": "Detail", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteInstanceCollection": { + "description": "Collection of site instances", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/SiteInstance" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "SiteInstance": { + "description": "Instance of a web app", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Name of instance", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "HostNameBindingCollection": { + "description": "Collection of host name bindings", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/HostNameBinding" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "HostNameBinding": { + "description": "A host name binding object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Hostname", + "type": "string" + }, + "siteName": { + "description": "Web app name", + "type": "string" + }, + "domainId": { + "description": "Fully qualified ARM domain resource URI", + "type": "string" + }, + "azureResourceName": { + "description": "Azure resource name", + "type": "string" + }, + "azureResourceType": { + "description": "Azure resource type", + "enum": [ + "Website", + "TrafficManager" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureResourceType", + "modelAsString": false + } + }, + "customHostNameDnsRecordType": { + "description": "Custom DNS record type", + "enum": [ + "CName", + "A" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHostNameDnsRecordType", + "modelAsString": false + } + }, + "hostNameType": { + "description": "Host name type", + "enum": [ + "Verified", + "Managed" + ], + "type": "string", + "x-ms-enum": { + "name": "HostNameType", + "modelAsString": false + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "SiteSourceControl": { + "description": "Describes the source control configuration for web app", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "repoUrl": { + "description": "Repository or source control url", + "type": "string" + }, + "branch": { + "description": "Name of branch to use for deployment", + "type": "string" + }, + "isManualIntegration": { + "description": "Whether to manual or continuous integration", + "type": "boolean" + }, + "deploymentRollbackEnabled": { + "description": "Whether to manual or continuous integration", + "type": "boolean" + }, + "isMercurial": { + "description": "Mercurial or Git repository type", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "StringDictionary": { + "description": "String dictionary resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Settings", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-client-flatten": true + } + } + }, + "ConnectionStringDictionary": { + "description": "String dictionary resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Connection strings", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConnStringValueTypePair" + }, + "x-ms-client-flatten": true + } + } + }, + "ConnStringValueTypePair": { + "description": "Database connection string value to type pair", + "required": [ + "type" + ], + "type": "object", + "properties": { + "value": { + "description": "Value of pair", + "type": "string" + }, + "type": { + "description": "Type of database", + "enum": [ + "MySql", + "SQLServer", + "SQLAzure", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseServerType", + "modelAsString": false + } + } + } + }, + "SiteLogsConfig": { + "description": "Configuration of Azure web site", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "applicationLogs": { + "$ref": "#/definitions/ApplicationLogsConfig", + "description": "Application logs configuration" + }, + "httpLogs": { + "$ref": "#/definitions/HttpLogsConfig", + "description": "Http logs configuration" + }, + "failedRequestsTracing": { + "$ref": "#/definitions/EnabledConfig", + "description": "Failed requests tracing configuration" + }, + "detailedErrorMessages": { + "$ref": "#/definitions/EnabledConfig", + "description": "Detailed error messages configuration" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ApplicationLogsConfig": { + "description": "Application logs configuration", + "type": "object", + "properties": { + "fileSystem": { + "$ref": "#/definitions/FileSystemApplicationLogsConfig", + "description": "Application logs to file system configuration" + }, + "azureTableStorage": { + "$ref": "#/definitions/AzureTableStorageApplicationLogsConfig", + "description": "Application logs to azure table storage configuration" + }, + "azureBlobStorage": { + "$ref": "#/definitions/AzureBlobStorageApplicationLogsConfig", + "description": "Application logs to blob storage configuration" + } + } + }, + "HttpLogsConfig": { + "description": "Http logs configuration", + "type": "object", + "properties": { + "fileSystem": { + "$ref": "#/definitions/FileSystemHttpLogsConfig", + "description": "Http logs to file system configuration" + }, + "azureBlobStorage": { + "$ref": "#/definitions/AzureBlobStorageHttpLogsConfig", + "description": "Http logs to azure blob storage configuration" + } + } + }, + "EnabledConfig": { + "description": "Enabled configuration", + "type": "object", + "properties": { + "enabled": { + "description": "Enabled", + "type": "boolean" + } + } + }, + "FileSystemApplicationLogsConfig": { + "description": "Application logs to file system configuration", + "type": "object", + "properties": { + "level": { + "description": "Log level", + "enum": [ + "Off", + "Verbose", + "Information", + "Warning", + "Error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": false + } + } + } + }, + "AzureTableStorageApplicationLogsConfig": { + "description": "Application logs to azure table storage configuration", + "type": "object", + "properties": { + "level": { + "description": "Log level", + "enum": [ + "Off", + "Verbose", + "Information", + "Warning", + "Error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": false + } + }, + "sasUrl": { + "description": "SAS url to an azure table with add/query/delete permissions", + "type": "string" + } + } + }, + "AzureBlobStorageApplicationLogsConfig": { + "description": "Application logs azure blob storage configuration", + "type": "object", + "properties": { + "level": { + "description": "Log level", + "enum": [ + "Off", + "Verbose", + "Information", + "Warning", + "Error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": false + } + }, + "sasUrl": { + "description": "SAS url to a azure blob container with read/write/list/delete permissions", + "type": "string" + }, + "retentionInDays": { + "format": "int32", + "description": "Retention in days.\r\n Remove blobs older than X days.\r\n 0 or lower means no retention.", + "type": "integer" + } + } + }, + "FileSystemHttpLogsConfig": { + "description": "Http logs to file system configuration", + "type": "object", + "properties": { + "retentionInMb": { + "format": "int32", + "description": "Maximum size in megabytes that http log files can use.\r\n When reached old log files will be removed to make space for new ones.\r\n Value can range between 25 and 100.", + "type": "integer" + }, + "retentionInDays": { + "format": "int32", + "description": "Retention in days.\r\n Remove files older than X days.\r\n 0 or lower means no retention.", + "type": "integer" + }, + "enabled": { + "description": "Enabled", + "type": "boolean" + } + } + }, + "AzureBlobStorageHttpLogsConfig": { + "description": "Http logs to azure blob storage configuration", + "type": "object", + "properties": { + "sasUrl": { + "description": "SAS url to a azure blob container with read/write/list/delete permissions", + "type": "string" + }, + "retentionInDays": { + "format": "int32", + "description": "Retention in days.\r\n Remove blobs older than X days.\r\n 0 or lower means no retention.", + "type": "integer" + }, + "enabled": { + "description": "Enabled", + "type": "boolean" + } + } + }, + "PremierAddOnRequest": { + "type": "object", + "properties": { + "location": { + "description": "Geo region resource belongs to e.g. SouthCentralUS, SouthEastAsia", + "type": "string" + }, + "tags": { + "description": "Tags associated with resource", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "plan": { + "$ref": "#/definitions/ArmPlan", + "description": "Azure resource manager plan" + }, + "properties": { + "$ref": "#/definitions/Object", + "description": "Resource specific properties" + }, + "sku": { + "$ref": "#/definitions/SkuDescription", + "description": "Sku description of the resource" + } + } + }, + "BackupRequest": { + "description": "Description of a backup which will be performed", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "required": [ + "type" + ], + "properties": { + "name": { + "description": "Name of the backup", + "type": "string" + }, + "enabled": { + "description": "True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled", + "type": "boolean" + }, + "storageAccountUrl": { + "description": "SAS URL to the container", + "type": "string" + }, + "backupSchedule": { + "$ref": "#/definitions/BackupSchedule", + "description": "Schedule for the backup if it is executed periodically" + }, + "databases": { + "description": "Databases included in the backup", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseBackupSetting" + } + }, + "type": { + "description": "Type of the backup", + "enum": [ + "Default", + "Clone", + "Relocation" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupRestoreOperationType", + "modelAsString": false + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "BackupSchedule": { + "description": "Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.", + "required": [ + "frequencyUnit" + ], + "type": "object", + "properties": { + "frequencyInterval": { + "format": "int32", + "description": "How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)", + "type": "integer" + }, + "frequencyUnit": { + "description": "How often should be the backup executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)", + "enum": [ + "Day", + "Hour" + ], + "type": "string", + "x-ms-enum": { + "name": "FrequencyUnit", + "modelAsString": false + } + }, + "keepAtLeastOneBackup": { + "description": "True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.", + "type": "boolean" + }, + "retentionPeriodInDays": { + "format": "int32", + "description": "After how many days backups should be deleted", + "type": "integer" + }, + "startTime": { + "format": "date-time", + "description": "When the schedule should start working", + "type": "string" + }, + "lastExecutionTime": { + "format": "date-time", + "description": "The last time when this schedule was triggered", + "type": "string" + } + } + }, + "DatabaseBackupSetting": { + "description": "Note: properties are serialized in JSON format and stored in DB. \r\n if new properties are added they might not be in the previous data rows \r\n so please handle nulls", + "type": "object", + "properties": { + "databaseType": { + "description": "SqlAzure / MySql", + "type": "string" + }, + "name": { + "type": "string" + }, + "connectionStringName": { + "description": "Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\r\n This is used during restore with overwrite connection strings options.", + "type": "string" + }, + "connectionString": { + "description": "Contains a connection string to a database which is being backed up/restored. If the restore should happen to a new database, the database name inside is the new one.", + "type": "string" + } + } + }, + "BackupItem": { + "description": "Backup description", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "required": [ + "status" + ], + "properties": { + "id": { + "format": "int32", + "description": "Id of the backup.", + "type": "integer" + }, + "storageAccountUrl": { + "description": "SAS URL for the storage account container which contains this backup", + "type": "string" + }, + "blobName": { + "description": "Name of the blob which contains data for this backup", + "type": "string" + }, + "name": { + "description": "Name of this backup", + "type": "string" + }, + "status": { + "description": "Backup status", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "TimedOut", + "Created", + "Skipped", + "PartiallySucceeded", + "DeleteInProgress", + "DeleteFailed", + "Deleted" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupItemStatus", + "modelAsString": false + } + }, + "sizeInBytes": { + "format": "int64", + "description": "Size of the backup in bytes", + "type": "integer" + }, + "created": { + "format": "date-time", + "description": "Timestamp of the backup creation", + "type": "string" + }, + "log": { + "description": "Details regarding this backup. Might contain an error message.", + "type": "string" + }, + "databases": { + "description": "List of databases included in the backup", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseBackupSetting" + } + }, + "scheduled": { + "description": "True if this backup has been created due to a schedule being triggered.", + "type": "boolean" + }, + "lastRestoreTimeStamp": { + "format": "date-time", + "description": "Timestamp of a last restore operation which used this backup.", + "type": "string" + }, + "finishedTimeStamp": { + "format": "date-time", + "description": "Timestamp when this backup finished.", + "type": "string" + }, + "correlationId": { + "description": "Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.", + "type": "string" + }, + "websiteSizeInBytes": { + "format": "int64", + "description": "Size of the original web app which has been backed up", + "type": "integer" + } + }, + "x-ms-client-flatten": true + } + } + }, + "RestoreRequest": { + "description": "Description of a restore request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "required": [ + "operationType" + ], + "properties": { + "storageAccountUrl": { + "description": "SAS URL to the container", + "type": "string" + }, + "blobName": { + "description": "Name of a blob which contains the backup", + "type": "string" + }, + "overwrite": { + "description": "True if the restore operation can overwrite target site. \"True\" needed if trying to restore over an existing site.", + "type": "boolean" + }, + "siteName": { + "description": "Name of a site (Web App)", + "type": "string" + }, + "databases": { + "description": "Collection of databses which should be restored. This list has to match the list of databases included in the backup.", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseBackupSetting" + } + }, + "ignoreConflictingHostNames": { + "description": "Changes a logic when restoring a site with custom domains. If \"true\", custom domains are removed automatically. If \"false\", custom domains are added to \r\n the site object when it is being restored, but that might fail due to conflicts during the operation.", + "type": "boolean" + }, + "operationType": { + "description": "Operation type", + "enum": [ + "Default", + "Clone", + "Relocation" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupRestoreOperationType", + "modelAsString": false + } + }, + "adjustConnectionStrings": { + "description": "Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site", + "type": "boolean" + }, + "hostingEnvironment": { + "description": "App Service Environment name, if needed (only when restoring a site to an App Service Environment)", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "BackupItemCollection": { + "description": "Collection of Backup Items", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/BackupItem" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "RestoreResponse": { + "description": "Response for a restore site request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "operationId": { + "description": "When server starts the restore process, it will return an OperationId identifying that particular restore operation", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "CsmPublishingProfileOptions": { + "description": "Publishing options for requested profile", + "type": "object", + "properties": { + "format": { + "description": "Name of the format. Valid values are: \r\n FileZilla3\r\n WebDeploy -- default\r\n Ftp", + "type": "string" + } + } + }, + "TopLevelDomainCollection": { + "description": "Collection of Top Level Domains", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/TopLevelDomain" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "TopLevelDomain": { + "description": "A top level domain object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "properties": { + "name": { + "description": "Name of the top level domain", + "type": "string" + }, + "privacy": { + "description": "If true then the top level domain supports domain privacy", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, + "TopLevelDomainAgreementOption": { + "description": "Options for retrieving the list of top level domain legal agreements", + "type": "object", + "properties": { + "includePrivacy": { + "description": "If true then the list of agreements will inclue agreements for domain privacy as well.", + "type": "boolean" + } + } + }, + "TldLegalAgreementCollection": { + "description": "Collection of Tld Legal Agreements", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources", + "type": "array", + "items": { + "$ref": "#/definitions/TldLegalAgreement" + } + }, + "nextLink": { + "description": "Link to next page of resources", + "type": "string" + } + } + }, + "TldLegalAgreement": { + "description": "Represents a legal agreement for top level domain", + "type": "object", + "properties": { + "agreementKey": { + "description": "Unique identifier for the agreement", + "type": "string" + }, + "title": { + "description": "Agreement title", + "type": "string" + }, + "content": { + "description": "Agreement details", + "type": "string" + }, + "url": { + "description": "Url where a copy of the agreement details is hosted", + "type": "string" + } + } + }, + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "description": "Resource Id", + "type": "string" + }, + "name": { + "description": "Resource Name", + "type": "string" + }, + "location": { + "description": "Resource Location", + "type": "string" + }, + "type": { + "description": "Resource type", + "type": "string" + }, + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API Version", + "required": true, + "type": "string" + } + } } \ No newline at end of file From 541ff45a97576e979ebe6b3862efda73374539b3 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Thu, 31 Mar 2016 12:44:50 -0700 Subject: [PATCH 06/18] Made PUT/PATCH/DELETE web services long running to account for async behavior --- .../swagger/webservices.json | 66 +++++++++++-------- 1 file changed, 37 insertions(+), 29 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index 231e2c93df37..a4381a7f6c5e 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -33,20 +33,33 @@ "$ref": "#/parameters/WebServiceNameParameter" }, { - "$ref": "#/parameters/APIVersionParameter" + "in": "body", + "name": "createOrUpdatePayload", + "description": "The payload to create or update a Web Service", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } }, { - "$ref": "#/parameters/CreateOrUpdateWebServiceRequestPayloadSchema" + "$ref": "#/parameters/APIVersionParameter" } ], "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/WebService" } } - } + }, + "x-ms-long-running-operation": true }, "get": { "operationId": "GetWebService", @@ -88,10 +101,16 @@ "$ref": "#/parameters/WebServiceNameParameter" }, { - "$ref": "#/parameters/APIVersionParameter" + "in": "body", + "name": "patchPayload", + "description": "[TODO] Patch Web Service Request Payload.", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } }, { - "$ref": "#/parameters/PatchWebServiceRequestPayloadSchema" + "$ref": "#/parameters/APIVersionParameter" } ], "responses": { @@ -101,7 +120,8 @@ "$ref": "#/definitions/WebService" } } - } + }, + "x-ms-long-running-operation": true }, "delete": { "operationId": "DeleteWebService", @@ -127,7 +147,8 @@ "204": { "description": "No-Content. The Web Service is not found." } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { @@ -288,25 +309,7 @@ "description": "Client Api Version.", "required": true, "enum": [ "2016-02-01-preview" ] - }, - "CreateOrUpdateWebServiceRequestPayloadSchema": { - "in": "body", - "name": "createOrUpdatePayload", - "description": "The payload to create or update a Web Service", - "required": true, - "schema": { - "$ref": "#/definitions/WebService" - } - }, - "PatchWebServiceRequestPayloadSchema": { - "in": "body", - "name": "patchPayload", - "description": "[TODO] Patch Web Service Request Payload. It indicates all fields could be pacthed.", - "required": true, - "schema": { - "$ref": "#/definitions/WebService" - } - }, + }, "CheckNameAvailabilitySchema": { "in": "body", "name": "checkNameAvailabilityPayload", @@ -357,12 +360,14 @@ "createdOn": { "type": "string", "description": "The moment of time the web service was created.", - "format": "date-time" + "format": "date-time", + "readOnly": true }, "modifiedOn": { "type": "string", "description": "The last moment of time the web service was last modified.", - "format": "date-time" + "format": "date-time", + "readOnly": true }, "provisioningState": { "type": "string", @@ -371,6 +376,7 @@ "Unknown", "Provisioning" ], + "readOnly": true, "x-ms-enum": { "name": "ProvisioningState", "modelAsString": false @@ -385,7 +391,8 @@ }, "swaggerLocation": { "type": "string", - "description": "The uri for the swagger spec associated with this web service" + "description": "The uri for the swagger spec associated with this web service", + "readOnly": true }, "realtimeConfiguration": { "description": "[TODO] Realtime configuration", @@ -433,6 +440,7 @@ "Code", "Graph" ], + "readOnly": true, "x-ms-enum": { "name": "PackageType", "modelAsString": false From 6bffce310e9237c529ce1528aaecff6af6f8c112 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Mon, 4 Apr 2016 15:10:48 -0700 Subject: [PATCH 07/18] - Fix DeleteWebService reesponse definition - Add $skiptoken query parameter to list web services APIs --- .../swagger/webservices.json | 25 +++++++++++++------ 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index a4381a7f6c5e..b5c984f1325c 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -141,11 +141,8 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No-Content. The Web Service is not found." + "202": { + "description": "Async delete operation was accepted." } }, "x-ms-long-running-operation": true @@ -192,6 +189,9 @@ }, { "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationSkipToken" } ], "responses": { @@ -214,6 +214,9 @@ }, { "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationSkipToken" } ], "responses": { @@ -307,9 +310,8 @@ "name": "api-version", "type": "string", "description": "Client Api Version.", - "required": true, - "enum": [ "2016-02-01-preview" ] - }, + "required": true + }, "CheckNameAvailabilitySchema": { "in": "body", "name": "checkNameAvailabilityPayload", @@ -328,6 +330,13 @@ } } } + }, + "PaginationSkipToken": { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false } }, "definitions": { From 74ee5fbbd56dd2b21dc73600c0ddb41c3eadbd60 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Mon, 4 Apr 2016 17:17:47 -0700 Subject: [PATCH 08/18] Fix PaginatedWebServicesList to have "value" property instead of "values" --- .../2016-04-01-privatepreview/swagger/webservices.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index b5c984f1325c..e3585c6e779e 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -546,7 +546,7 @@ "type": "object", "description": "[TODO] Paginated list of web services", "properties": { - "values": { + "value": { "type": "array", "description": "List of Web Services", "items": { From 52ab7c872443b8f0726cb7509f89b15f3f3bc560 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Tue, 5 Apr 2016 10:56:57 -0700 Subject: [PATCH 09/18] Added missing values to ProvisioningState enum --- .../2016-04-01-privatepreview/swagger/webservices.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index e3585c6e779e..f75f327c7881 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -383,7 +383,10 @@ "description": "[TODO] web service's provisioning state", "enum": [ "Unknown", - "Provisioning" + "Provisioning", + "Succeeded", + "Failed", + "Canceled" ], "readOnly": true, "x-ms-enum": { From 389cd88105313aa03d30868d4b4882ebfb782b22 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Mon, 11 Apr 2016 11:42:52 -0700 Subject: [PATCH 10/18] - added type property to GraphParameter of enum type ParameterType - removed the API definition for : /subscriptions/{subscriptionId}/providers/Microsoft/MachineLearning/checkNameAvailability as this is not an implemented API at this time - made some corrections / additions to schema description elements --- .../swagger/webservices.json | 211 +++++++----------- 1 file changed, 84 insertions(+), 127 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index f75f327c7881..1857d868d752 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Machine Learning Web Services Management Client APIs", - "description": "These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:
  • Create a Web Service
  • Get a Web Service
  • Patch a Web Service
  • Delete a Web Service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
  • Check Name Availability
  • Get All Available Operations
", + "description": "[TODO] These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:
  • Create a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
  • Check Name Availability
  • Get All Available Operations
", "version": "2016-04-01-privatepreview" }, "host": "management.azure.com", @@ -21,7 +21,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { "put": { "operationId": "CreateOrUpdateWebService", - "description": "Create a new Web Service or update an existing one.", + "description": "Create a new Azure ML web service or update an existing one.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -35,7 +35,7 @@ { "in": "body", "name": "createOrUpdatePayload", - "description": "The payload to create or update a Web Service", + "description": "The payload to create or update the Azure ML web service.", "required": true, "schema": { "$ref": "#/definitions/WebService" @@ -59,11 +59,11 @@ } } }, - "x-ms-long-running-operation": true + "x-ms-long-running-operation": true }, "get": { "operationId": "GetWebService", - "description": "Retrieve a Web Service information by its name", + "description": "Retrieve an Azure ML web service definition by its subscription, resource group and name.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -89,7 +89,7 @@ }, "patch": { "operationId": "PatchWebService", - "description": "Patch an existing Web Service", + "description": "Patch an existing Azure ML web service.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -103,7 +103,7 @@ { "in": "body", "name": "patchPayload", - "description": "[TODO] Patch Web Service Request Payload.", + "description": "The payload to patch the Azure ML with.", "required": true, "schema": { "$ref": "#/definitions/WebService" @@ -125,7 +125,7 @@ }, "delete": { "operationId": "DeleteWebService", - "description": "Delete an existing Web Service", + "description": "Remove an existing Azure ML web service.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -142,7 +142,7 @@ ], "responses": { "202": { - "description": "Async delete operation was accepted." + "description": "Async delete operation was accepted." } }, "x-ms-long-running-operation": true @@ -151,7 +151,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { "get": { "operationId": "GetWebServiceKeys", - "description": "Get the primary and secondary keys of a particular Web Service", + "description": "Get the primary and secondary access keys of a particular Azure ML web service", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -179,7 +179,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { "get": { "operationId": "GetWebServicesInResourceGroup", - "description": "Retrieve all Web Services' information in a given Resource Group", + "description": "Retrieve all Azure ML web services in a given resource group.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -207,7 +207,7 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { "get": { "operationId": "GetWebServicesInSubscription", - "description": "Get all Web Services' information in current Azure subscription", + "description": "Retrieve all Azure ML web services in the current Azure subscription.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -228,36 +228,11 @@ } } } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft/MachineLearning/checkNameAvailability": { - "post": { - "operationId": "CheckNameAvaliability", - "description": "Check the Web Service Name is valid and not in use", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/CheckNameAvailabilitySchema" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CheckNameResult" - } - } - } - } - }, + }, "/providers/Microsoft.MachineLearning/operations": { "get": { "operationId": "GetOperations", - "description": "Get all available operations of a Web Service", + "description": "Get all available operations for the Microsoft.MachineLearning provider.", "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -286,7 +261,7 @@ "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "description": "Id of the Microsoft Azure subscription on which to perform ARM operations. The subscription ID forms part of the URI for every service call.", "in": "path", "type": "string", "required": true @@ -300,7 +275,7 @@ }, "WebServiceNameParameter": { "name": "webServiceName", - "description": "The Web Service name which you want to reach.", + "description": "The Azure ML web service name which you want to reach.", "in": "path", "type": "string", "required": true @@ -309,28 +284,9 @@ "in": "query", "name": "api-version", "type": "string", - "description": "Client Api Version.", + "description": "The versiong of the Microsoft.MachineLearning resource provider API to be used.", "required": true }, - "CheckNameAvailabilitySchema": { - "in": "body", - "name": "checkNameAvailabilityPayload", - "description": "The payload to check name availability", - "required": true, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The Web Service Name" - }, - "type": { - "type": "string", - "description": "The Web Service Type" - } - } - } - }, "PaginationSkipToken": { "in": "query", "name": "$skiptoken", @@ -342,7 +298,7 @@ "definitions": { "WebService": { "type": "object", - "title": "[TODO] The Web Service Object", + "title": "[TODO] Instance of an Azure ML web service resource.", "allOf": [ { "$ref": "#/definitions/Resource" @@ -356,7 +312,7 @@ }, "WebServiceProperties": { "type": "object", - "description": "The definition of the web service being deployed.", + "description": "The set of properties specific to the Azure ML web service resource.", "required": [ "packageType" ], @@ -364,23 +320,23 @@ "properties": { "description": { "type": "string", - "description": "The description the web service" + "description": "The description the Azure ML web service" }, "createdOn": { "type": "string", - "description": "The moment of time the web service was created.", + "description": "The moment of time the Azure ML web service was created.", "format": "date-time", "readOnly": true }, "modifiedOn": { "type": "string", - "description": "The last moment of time the web service was last modified.", + "description": "The moment of time the web service was last modified.", "format": "date-time", "readOnly": true }, "provisioningState": { "type": "string", - "description": "[TODO] web service's provisioning state", + "description": "The web service resource's provisioning state.", "enum": [ "Unknown", "Provisioning", @@ -399,11 +355,11 @@ }, "readOnly": { "type": "boolean", - "description": "True, if the Web Service should be read-only; False, otherwise" + "description": "True, if the web service should be read-only; False, otherwise" }, "swaggerLocation": { "type": "string", - "description": "The uri for the swagger spec associated with this web service", + "description": "The uri for the swagger spec associated with this Azure ML web service.", "readOnly": true }, "realtimeConfiguration": { @@ -533,7 +489,7 @@ }, "WebServiceKeys": { "type": "object", - "description": "Web Service Keys", + "description": "web service Keys", "properties": { "primary": { "type": "string", @@ -562,49 +518,6 @@ } } }, - "OperationSchema": { - "type": "object", - "description": "[TODO] The Web Service Operation Description", - "properties": { - "name": { - "type": "string", - "description": "The operation name" - }, - "display": { - "type": "object", - "description": "[TODO] Display", - "properties": { - "provider": { - "type": "string", - "description": "[TODO] Provider", - "default": "Machine Learning" - }, - "resource": { - "type": "string", - "description": "[TODO] Resource", - "default": "Web Service" - }, - "operation": { - "type": "string", - "description": "[TODO] Operation" - }, - "description": { - "type": "string", - "description": "[TODO] Description" - } - } - }, - "origin": { - "type": "string", - "description": "[TODO] Origin", - "enum": [ - "user", - "system", - "user, system" - ] - } - } - }, "RealtimeConfiguration": { "type": "object", "description": "Configuration settings for RRS", @@ -882,7 +795,29 @@ "properties": { "description": { "type": "string", - "description": "[TODO] Description of this Graph parameter" + "description": "Description for this graph parameter." + }, + "type": { + "type": "string", + "description": "Graph parameter's type.", + "enum": [ + "String", + "Int", + "Float", + "Enumerated", + "Script", + "Mode", + "Credential", + "Boolean", + "Double", + "ColumnPicker", + "ParameterRange", + "DataGatewayName" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": false + } }, "links": { "type": "array", @@ -906,7 +841,7 @@ "description": "[TODO] The parameter key" } } - }, + }, "Resource": { "required": [ "location" @@ -937,24 +872,46 @@ } } }, - "CheckNameResult": { + "OperationSchema": { "type": "object", + "description": "[TODO] The web service Operation Description", "properties": { - "nameAvaliable": { - "type": "boolean", - "description": "True, if the name is available; False, otherwise" + "name": { + "type": "string", + "description": "The operation name" + }, + "display": { + "type": "object", + "description": "[TODO] Display", + "properties": { + "provider": { + "type": "string", + "description": "[TODO] Provider", + "default": "Machine Learning" + }, + "resource": { + "type": "string", + "description": "[TODO] Resource", + "default": "web service" + }, + "operation": { + "type": "string", + "description": "[TODO] Operation" + }, + "description": { + "type": "string", + "description": "[TODO] Description" + } + } }, - "reason": { + "origin": { "type": "string", - "description": "The reason why if it is not available", + "description": "[TODO] Origin", "enum": [ - "Invalid", - "AlreadyExists" + "user", + "system", + "user, system" ] - }, - "message": { - "type": "string", - "description": ": The message from the server" } } } From 03a7d33e177bb678828fd90bfaa528e673673d8d Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Wed, 13 Apr 2016 16:30:59 -0700 Subject: [PATCH 11/18] Refactored global parameters definition to allow generation of some parameters in the metod signature for generated code. --- .../swagger/webservices.json | 1316 ++++++++--------- 1 file changed, 653 insertions(+), 663 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index 1857d868d752..5c4d43ccb11b 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "Machine Learning Web Services Management Client APIs", - "description": "[TODO] These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:
  • Create a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
  • Check Name Availability
  • Get All Available Operations
", + "title": "AzureML Web Services Management Client", + "description": "[TODO] These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:
  • Create a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
  • Get All Available Operations
", "version": "2016-04-01-privatepreview" }, "host": "management.azure.com", @@ -20,18 +20,12 @@ "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { "put": { - "operationId": "CreateOrUpdateWebService", + "tags": [ + "WebServices" + ], + "operationId": "WebServices_CreateOrUpdateWebService", "description": "Create a new Azure ML web service or update an existing one.", "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, { "in": "body", "name": "createOrUpdatePayload", @@ -40,9 +34,6 @@ "schema": { "$ref": "#/definitions/WebService" } - }, - { - "$ref": "#/parameters/APIVersionParameter" } ], "responses": { @@ -62,22 +53,11 @@ "x-ms-long-running-operation": true }, "get": { - "operationId": "GetWebService", - "description": "Retrieve an Azure ML web service definition by its subscription, resource group and name.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } + "tags": [ + "WebServices" ], + "operationId": "WebServices_GetWebService", + "description": "Retrieve an Azure ML web service definition by its subscription, resource group and name.", "responses": { "200": { "description": "OK", @@ -88,18 +68,12 @@ } }, "patch": { - "operationId": "PatchWebService", + "tags": [ + "WebServices" + ], + "operationId": "WebServices_PatchWebService", "description": "Patch an existing Azure ML web service.", "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, { "in": "body", "name": "patchPayload", @@ -108,9 +82,6 @@ "schema": { "$ref": "#/definitions/WebService" } - }, - { - "$ref": "#/parameters/APIVersionParameter" } ], "responses": { @@ -124,43 +95,65 @@ "x-ms-long-running-operation": true }, "delete": { - "operationId": "DeleteWebService", - "description": "Remove an existing Azure ML web service.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } + "tags": [ + "WebServices" ], + "operationId": "WebServices_RemoveWebService", + "description": "Remove an existing Azure ML web service.", "responses": { "202": { "description": "Async delete operation was accepted." } }, "x-ms-long-running-operation": true - } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "webServiceName", + "description": "The Azure ML web service name which you want to reach.", + "in": "path", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ] }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { "get": { - "operationId": "GetWebServiceKeys", + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServiceKeys", "description": "Get the primary and secondary access keys of a particular Azure ML web service", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true }, { - "$ref": "#/parameters/WebServiceNameParameter" + "name": "webServiceName", + "description": "The Azure ML web service name which you want to reach.", + "in": "path", + "type": "string", + "required": true }, { "$ref": "#/parameters/APIVersionParameter" @@ -178,20 +171,31 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { "get": { - "operationId": "GetWebServicesInResourceGroup", + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServicesInResourceGroup", "description": "Retrieve all Azure ML web services in a given resource group.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true }, { "$ref": "#/parameters/APIVersionParameter" }, { - "$ref": "#/parameters/PaginationSkipToken" + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false } ], "responses": { @@ -206,7 +210,10 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { "get": { - "operationId": "GetWebServicesInSubscription", + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServicesInSubscription", "description": "Retrieve all Azure ML web services in the current Azure subscription.", "parameters": [ { @@ -216,7 +223,11 @@ "$ref": "#/parameters/APIVersionParameter" }, { - "$ref": "#/parameters/PaginationSkipToken" + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false } ], "responses": { @@ -228,7 +239,7 @@ } } } - }, + }, "/providers/Microsoft.MachineLearning/operations": { "get": { "operationId": "GetOperations", @@ -261,21 +272,7 @@ "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", - "description": "Id of the Microsoft Azure subscription on which to perform ARM operations. The subscription ID forms part of the URI for every service call.", - "in": "path", - "type": "string", - "required": true - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "description": "The name of the resource group within the user's subscription.", - "in": "path", - "type": "string", - "required": true - }, - "WebServiceNameParameter": { - "name": "webServiceName", - "description": "The Azure ML web service name which you want to reach.", + "description": "Azure subscription id.", "in": "path", "type": "string", "required": true @@ -285,635 +282,628 @@ "name": "api-version", "type": "string", "description": "The versiong of the Microsoft.MachineLearning resource provider API to be used.", - "required": true - }, - "PaginationSkipToken": { - "in": "query", - "name": "$skiptoken", - "type": "string", - "description": "Continuation token for pagination.", - "required": false + "required": true } }, "definitions": { - "WebService": { - "type": "object", - "title": "[TODO] Instance of an Azure ML web service resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { + "WebService": { + "type": "object", + "title": "[TODO] Instance of an Azure ML web service resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], "properties": { - "$ref": "#/definitions/WebServiceProperties" + "properties": { + "$ref": "#/definitions/WebServiceProperties" + } } - } - }, - "WebServiceProperties": { - "type": "object", - "description": "The set of properties specific to the Azure ML web service resource.", - "required": [ - "packageType" - ], - "discriminator": "packageType", - "properties": { - "description": { - "type": "string", - "description": "The description the Azure ML web service" - }, - "createdOn": { - "type": "string", - "description": "The moment of time the Azure ML web service was created.", - "format": "date-time", - "readOnly": true - }, - "modifiedOn": { - "type": "string", - "description": "The moment of time the web service was last modified.", - "format": "date-time", - "readOnly": true - }, - "provisioningState": { - "type": "string", - "description": "The web service resource's provisioning state.", - "enum": [ - "Unknown", - "Provisioning", - "Succeeded", - "Failed", - "Canceled" - ], - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false + }, + "WebServiceProperties": { + "type": "object", + "description": "The set of properties specific to the Azure ML web service resource.", + "required": [ + "packageType" + ], + "discriminator": "packageType", + "properties": { + "description": { + "type": "string", + "description": "The description the Azure ML web service" + }, + "createdOn": { + "type": "string", + "description": "The moment of time the Azure ML web service was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "type": "string", + "description": "The moment of time the web service was last modified.", + "format": "date-time", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "The web service resource's provisioning state.", + "enum": [ + "Unknown", + "Provisioning", + "Succeeded", + "Failed", + "Canceled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys" + }, + "readOnly": { + "type": "boolean", + "description": "True, if the web service should be read-only; False, otherwise" + }, + "swaggerLocation": { + "type": "string", + "description": "The uri for the swagger spec associated with this Azure ML web service.", + "readOnly": true + }, + "realtimeConfiguration": { + "description": "[TODO] Realtime configuration", + "$ref": "#/definitions/RealtimeConfiguration" + }, + "diagnostics": { + "description": "[TODO] Diagnostics settings", + "$ref": "#/definitions/DiagnosticsConfiguration" + }, + "storageAccount": { + "description": "[TODO] BYOS description", + "$ref": "#/definitions/StorageAccount" + }, + "machineLearningWorkspace": { + "description": "[TODO] Service workspace data", + "$ref": "#/definitions/MachineLearningWorkspace" + }, + "commitmentPlan": { + "description": "[TODO] Service commitment plan data", + "$ref": "#/definitions/CommitmentPlan" + }, + "input": { + "description": "[TODO] Service input definition", + "$ref": "#/definitions/ServiceInputOutputSpecification" + }, + "output": { + "description": "[TODO] Service output definition", + "$ref": "#/definitions/ServiceInputOutputSpecification" + }, + "assets": { + "description": "[TODO] Service assets", + "$ref": "#/definitions/AssetProperties" + }, + "parameters": { + "type": "object", + "description": "[TODO] Parameters of module package", + "additionalProperties": { + "type": "string" + } + }, + "packageType": { + "type": "string", + "description": "[TODO] Module package type", + "enum": [ + "Code", + "Graph" + ], + "readOnly": true, + "x-ms-enum": { + "name": "PackageType", + "modelAsString": false + } } - }, - "keys": { - "$ref": "#/definitions/WebServiceKeys" - }, - "readOnly": { - "type": "boolean", - "description": "True, if the web service should be read-only; False, otherwise" - }, - "swaggerLocation": { - "type": "string", - "description": "The uri for the swagger spec associated with this Azure ML web service.", - "readOnly": true - }, - "realtimeConfiguration": { - "description": "[TODO] Realtime configuration", - "$ref": "#/definitions/RealtimeConfiguration" - }, - "diagnostics": { - "description": "[TODO] Diagnostics settings", - "$ref": "#/definitions/DiagnosticsConfiguration" - }, - "storageAccount": { - "description": "[TODO] BYOS description", - "$ref": "#/definitions/StorageAccount" - }, - "machineLearningWorkspace": { - "description": "[TODO] Service workspace data", - "$ref": "#/definitions/MachineLearningWorkspace" - }, - "commitmentPlan": { - "description": "[TODO] Service commitment plan data", - "$ref": "#/definitions/CommitmentPlan" - }, - "input": { - "description": "[TODO] Service input definition", - "$ref": "#/definitions/ServiceInputOutputSpecification" - }, - "output": { - "description": "[TODO] Service output definition", - "$ref": "#/definitions/ServiceInputOutputSpecification" - }, - "assets": { - "description": "[TODO] Service assets", - "$ref": "#/definitions/AssetProperties" - }, - "parameters": { - "type": "object", - "description": "[TODO] Parameters of module package", - "additionalProperties": { - "type": "string" + } + }, + "WebServicePropertiesForGraph": { + "description": "[TODO] Payload for Graph package", + "x-ms-discriminator-value": "Graph", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" } - }, - "packageType": { - "type": "string", - "description": "[TODO] Module package type", - "enum": [ - "Code", - "Graph" - ], - "readOnly": true, - "x-ms-enum": { - "name": "PackageType", - "modelAsString": false + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Graph Package", + "properties": { + "nodes": { + "type": "object", + "description": "[TODO] Graph nodes collection", + "additionalProperties": { + "$ref": "#/definitions/GraphNode" + } + }, + "edges": { + "type": "array", + "description": "[TODO] List of Graph Edges", + "items": { + "$ref": "#/definitions/GraphEdge" + } + }, + "graphParameters": { + "type": "object", + "description": "[TODO] Graph parameter collection", + "additionalProperties": { + "$ref": "#/definitions/GraphParameter" + } + } + } } } - } - }, - "WebServicePropertiesForGraph": { - "description": "[TODO] Payload for Graph package", - "x-ms-discriminator-value": "Graph", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" - } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Graph Package", - "properties": { - "nodes": { - "type": "object", - "description": "[TODO] Graph nodes collection", - "additionalProperties": { - "$ref": "#/definitions/GraphNode" - } - }, - "edges": { - "type": "array", - "description": "[TODO] List of Graph Edges", - "items": { - "$ref": "#/definitions/GraphEdge" - } - }, - "graphParameters": { - "type": "object", - "description": "[TODO] Graph parameter collection", - "additionalProperties": { - "$ref": "#/definitions/GraphParameter" + }, + "WebServicePropertiesForCode": { + "description": "[TODO] Payload for Code package", + "x-ms-discriminator-value": "Code", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Code Package", + "properties": { + "language": { + "type": "string", + "description": "[TODO] The language of source code", + "enum": [ + "Python-2.7", + "R-3.1" + ] + }, + "sourceCode": { + "type": "string", + "description": "[TODO] The source code" + }, + "zipFileAssetId": { + "type": "string", + "description": "[TODO] Zip file's Asset ID" } } } } - } - }, - "WebServicePropertiesForCode": { - "description": "[TODO] Payload for Code package", - "x-ms-discriminator-value": "Code", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" + }, + "WebServiceKeys": { + "type": "object", + "description": "web service Keys", + "properties": { + "primary": { + "type": "string", + "description": "The Primary Key" + }, + "secondary": { + "type": "string", + "description": "The Secondary Key" + } } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Code Package", - "properties": { - "language": { - "type": "string", - "description": "[TODO] The language of source code", - "enum": [ - "Python-2.7", - "R-3.1" - ] - }, - "sourceCode": { - "type": "string", - "description": "[TODO] The source code" - }, - "zipFileAssetId": { - "type": "string", - "description": "[TODO] Zip file's Asset ID" + }, + "PaginatedWebServicesList": { + "type": "object", + "description": "[TODO] Paginated list of web services", + "properties": { + "value": { + "type": "array", + "description": "List of Web Services", + "items": { + "$ref": "#/definitions/WebService" } + }, + "nextLink": { + "type": "string", + "description": "[TODO] Next Link" } } - } - }, - "WebServiceKeys": { - "type": "object", - "description": "web service Keys", - "properties": { - "primary": { - "type": "string", - "description": "The Primary Key" - }, - "secondary": { - "type": "string", - "description": "The Secondary Key" - } - } - }, - "PaginatedWebServicesList": { - "type": "object", - "description": "[TODO] Paginated list of web services", - "properties": { - "value": { - "type": "array", - "description": "List of Web Services", - "items": { - "$ref": "#/definitions/WebService" + }, + "RealtimeConfiguration": { + "type": "object", + "description": "Configuration settings for RRS", + "properties": { + "maxConcurrentCalls": { + "type": "integer", + "description": "[TODO] Max Concurrent Calls" } - }, - "nextLink": { - "type": "string", - "description": "[TODO] Next Link" } - } - }, - "RealtimeConfiguration": { - "type": "object", - "description": "Configuration settings for RRS", - "properties": { - "maxConcurrentCalls": { - "type": "integer", - "description": "[TODO] Max Concurrent Calls" - } - } - }, - "DiagnosticsConfiguration": { - "type": "object", - "description": "The Diagnostics Settings", - "properties": { - "level": { - "type": "string", - "description": "Trace Level: None, Error, All", - "enum": [ - "None", - "Error", - "All" - ], - "x-ms-enum": { - "name": "DiagnosticsLevel", - "modelAsString": false + }, + "DiagnosticsConfiguration": { + "type": "object", + "description": "The Diagnostics Settings", + "properties": { + "level": { + "type": "string", + "description": "Trace Level: None, Error, All", + "enum": [ + "None", + "Error", + "All" + ], + "x-ms-enum": { + "name": "DiagnosticsLevel", + "modelAsString": false + } + }, + "expiry": { + "type": "string", + "description": "[TODO] Expiry date", + "format": "date-time" } - }, - "expiry": { - "type": "string", - "description": "[TODO] Expiry date", - "format": "date-time" } - } - }, - "StorageAccount": { - "type": "object", - "description": "[TODO] The Storage Account used in GraphSharp", - "properties": { - "name": { - "type": "string", - "description": "[TODO] The storage account's name" - }, - "primaryKey": { - "type": "string", - "description": "[TODO] The storage account's primary key" - }, - "secondaryKey": { - "type": "string", - "description": "[TODO] The storage account's secondary key" - } - } - }, - "MachineLearningWorkspace": { - "type": "object", - "description": "[TODO] The machine learning workspace", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The Workspace ID" - } - } - }, - "CommitmentPlan": { - "type": "object", - "description": "[TODO] The commitment plan associated with this web service", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The plan's ID" + }, + "StorageAccount": { + "type": "object", + "description": "[TODO] The Storage Account used in GraphSharp", + "properties": { + "name": { + "type": "string", + "description": "[TODO] The storage account's name" + }, + "primaryKey": { + "type": "string", + "description": "[TODO] The storage account's primary key" + }, + "secondaryKey": { + "type": "string", + "description": "[TODO] The storage account's secondary key" + } } - } - }, - "ServiceInputOutputSpecification": { - "type": "object", - "description": "[TODO] The swagger schema describing the service's input.", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Interface title" - }, - "description": { - "type": "string", - "description": "[TODO] Description of the interface" - }, - "type": { - "type": "string", - "description": "[TODO] Interface properties' type. Always use 'object' here.", - "default": "object" - }, + }, + "MachineLearningWorkspace": { + "type": "object", + "description": "[TODO] The machine learning workspace", "properties": { - "type": "object", - "description": "[TODO]", - "additionalProperties": { - "$ref": "#/definitions/TableSpecification" + "id": { + "type": "string", + "description": "[TODO] The Workspace ID" } } - } - }, - "TableSpecification": { - "type": "object", - "description": "[TODO] schema for a data table", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Table title" - }, - "description": { - "type": "string", - "description": "[TODO] Table description" - }, - "type": { - "type": "string", - "description": "[TODO] Table properties' type. Always use 'object' here.", - "default": "object" - }, + }, + "CommitmentPlan": { + "type": "object", + "description": "[TODO] The commitment plan associated with this web service", "properties": { - "type": "object", - "description": "The set of columns within the data table", - "additionalProperties": { - "$ref": "#/definitions/ColumnSpecification" + "id": { + "type": "string", + "description": "[TODO] The plan's ID" } } - } - }, - "ColumnSpecification": { - "type": "object", - "description": "[TODO] input column.", - "properties": { - "type": { - "type": "string", - "description": "[TODO] Data type" - }, - "format": { - "type": "string", - "description": "[TODO] Data format" - }, - "enum": { - "type": "array", - "description": "[TODO] Options", - "items": { - "type": "object" + }, + "ServiceInputOutputSpecification": { + "type": "object", + "description": "[TODO] The swagger schema describing the service's input.", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Interface title" + }, + "description": { + "type": "string", + "description": "[TODO] Description of the interface" + }, + "type": { + "type": "string", + "description": "[TODO] Interface properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "object", + "description": "[TODO]", + "additionalProperties": { + "$ref": "#/definitions/TableSpecification" + } } - }, - "x-ms-isnullable": { - "type": "boolean", - "description": "[TODO] Is nullable" - }, - "x-ms-isordered": { - "type": "boolean", - "description": "[TODO] Is enum in order" } - } - }, - "AssetProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetItem" - } - }, - "AssetItem": { - "type": "object", - "description": "[TODO] Service asset details", - "properties": { - "name": { - "type": "string", - "description": "Module friendly name" - }, - "type": { - "type": "string", - "description": "Module type", - "default": "module" - }, - "location": { - "$ref": "#/definitions/AssetLocation" - }, - "inputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/InputPort" + }, + "TableSpecification": { + "type": "object", + "description": "[TODO] schema for a data table", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Table title" + }, + "description": { + "type": "string", + "description": "[TODO] Table description" + }, + "type": { + "type": "string", + "description": "[TODO] Table properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "object", + "description": "The set of columns within the data table", + "additionalProperties": { + "$ref": "#/definitions/ColumnSpecification" + } } - }, - "outputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/OutputPort" + } + }, + "ColumnSpecification": { + "type": "object", + "description": "[TODO] input column.", + "properties": { + "type": { + "type": "string", + "description": "[TODO] Data type" + }, + "format": { + "type": "string", + "description": "[TODO] Data format" + }, + "enum": { + "type": "array", + "description": "[TODO] Options", + "items": { + "type": "object" + } + }, + "x-ms-isnullable": { + "type": "boolean", + "description": "[TODO] Is nullable" + }, + "x-ms-isordered": { + "type": "boolean", + "description": "[TODO] Is enum in order" } } - } - }, - "AssetLocation": { - "type": "object", - "description": "[TODO] Asset Location", - "properties": { - "uri": { - "type": "string", - "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", - "format": "url" - }, - "credentials": { - "type": "string", - "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." + }, + "AssetProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetItem" } - } - }, - "InputPort": { - "type": "object", - "description": "[TODO] Asset input port", - "properties": { - "type": { - "type": "string", - "description": "[TODO] dataset or zip" + }, + "AssetItem": { + "type": "object", + "description": "[TODO] Service asset details", + "properties": { + "name": { + "type": "string", + "description": "Module friendly name" + }, + "type": { + "type": "string", + "description": "Module type", + "default": "module" + }, + "location": { + "$ref": "#/definitions/AssetLocation" + }, + "inputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/InputPort" + } + }, + "outputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/OutputPort" + } + } } - } - }, - "OutputPort": { - "type": "object", - "description": "[TODO] Asset output port", - "properties": { - "type": { - "type": "string", - "description": "[TODO] dataset or zip" + }, + "AssetLocation": { + "type": "object", + "description": "[TODO] Asset Location", + "properties": { + "uri": { + "type": "string", + "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", + "format": "url" + }, + "credentials": { + "type": "string", + "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." + } } - } - }, - "GraphNode": { - "type": "object", - "description": "[TODO] Graph Node", - "properties": { - "assetId": { - "type": "string", - "description": "[TODO] Asset ID" - }, - "inputId": { - "type": "string", - "description": "[TODO] Input ID" - }, - "outputId": { - "type": "string", - "description": "[TODO] Output ID" - }, - "parameters": { - "type": "object", - "description": "[TODO] Node Parameters", - "additionalProperties": { - "type": "string" + }, + "InputPort": { + "type": "object", + "description": "[TODO] Asset input port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" } } - } - }, - "GraphEdge": { - "type": "object", - "description": "[TODO] Graph edge", - "properties": { - "sourceNodeId": { - "type": "string", - "description": "[TODO] Edge source" - }, - "sourcePortId": { - "type": "string", - "description": "[TODO] Source node output port id" - }, - "targetNodeId": { - "type": "string", - "description": "[TODO] Edge target" - }, - "targetPortId": { - "type": "string", - "description": "[TODO] Target node input port id" + }, + "OutputPort": { + "type": "object", + "description": "[TODO] Asset output port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" + } } - } - }, - "GraphParameter": { - "type": "object", - "description": "[TODO] Graph Parameters", - "properties": { - "description": { - "type": "string", - "description": "Description for this graph parameter." - }, - "type": { - "type": "string", - "description": "Graph parameter's type.", - "enum": [ - "String", - "Int", - "Float", - "Enumerated", - "Script", - "Mode", - "Credential", - "Boolean", - "Double", - "ColumnPicker", - "ParameterRange", - "DataGatewayName" - ], - "x-ms-enum": { - "name": "ParameterType", - "modelAsString": false + }, + "GraphNode": { + "type": "object", + "description": "[TODO] Graph Node", + "properties": { + "assetId": { + "type": "string", + "description": "[TODO] Asset ID" + }, + "inputId": { + "type": "string", + "description": "[TODO] Input ID" + }, + "outputId": { + "type": "string", + "description": "[TODO] Output ID" + }, + "parameters": { + "type": "object", + "description": "[TODO] Node Parameters", + "additionalProperties": { + "type": "string" + } } - }, - "links": { - "type": "array", - "description": "[TODO] Links of this parameter", - "items": { - "$ref": "#/definitions/GraphParameterLink" + } + }, + "GraphEdge": { + "type": "object", + "description": "[TODO] Graph edge", + "properties": { + "sourceNodeId": { + "type": "string", + "description": "[TODO] Edge source" + }, + "sourcePortId": { + "type": "string", + "description": "[TODO] Source node output port id" + }, + "targetNodeId": { + "type": "string", + "description": "[TODO] Edge target" + }, + "targetPortId": { + "type": "string", + "description": "[TODO] Target node input port id" } } - } - }, - "GraphParameterLink": { - "type": "object", - "description": "[TODO] The link in graph parameter", - "properties": { - "nodeId": { - "type": "string", - "description": "[TODO] The node ID" - }, - "parameterKey": { - "type": "string", - "description": "[TODO] The parameter key" + }, + "GraphParameter": { + "type": "object", + "description": "[TODO] Graph Parameters", + "properties": { + "description": { + "type": "string", + "description": "Description for this graph parameter." + }, + "type": { + "type": "string", + "description": "Graph parameter's type.", + "enum": [ + "String", + "Int", + "Float", + "Enumerated", + "Script", + "Mode", + "Credential", + "Boolean", + "Double", + "ColumnPicker", + "ParameterRange", + "DataGatewayName" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": false + } + }, + "links": { + "type": "array", + "description": "[TODO] Links of this parameter", + "items": { + "$ref": "#/definitions/GraphParameterLink" + } + } } - } - }, - "Resource": { - "required": [ - "location" - ], - "properties": { - "id": { - "description": "Resource Id", - "type": "string" - }, - "name": { - "description": "Resource Name", - "type": "string" - }, - "location": { - "description": "Resource Location", - "type": "string" - }, - "type": { - "description": "Resource type", - "type": "string" - }, - "tags": { - "description": "Resource tags", - "type": "object", - "additionalProperties": { + }, + "GraphParameterLink": { + "type": "object", + "description": "[TODO] The link in graph parameter", + "properties": { + "nodeId": { + "type": "string", + "description": "[TODO] The node ID" + }, + "parameterKey": { + "type": "string", + "description": "[TODO] The parameter key" + } + } + }, + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "description": "Resource Id", + "type": "string" + }, + "name": { + "description": "Resource Name", + "type": "string" + }, + "location": { + "description": "Resource Location", + "type": "string" + }, + "type": { + "description": "Resource type", "type": "string" + }, + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } } } - } - }, - "OperationSchema": { - "type": "object", - "description": "[TODO] The web service Operation Description", - "properties": { - "name": { - "type": "string", - "description": "The operation name" - }, - "display": { - "type": "object", - "description": "[TODO] Display", - "properties": { - "provider": { - "type": "string", - "description": "[TODO] Provider", - "default": "Machine Learning" - }, - "resource": { - "type": "string", - "description": "[TODO] Resource", - "default": "web service" - }, - "operation": { - "type": "string", - "description": "[TODO] Operation" - }, - "description": { - "type": "string", - "description": "[TODO] Description" + }, + "OperationSchema": { + "type": "object", + "description": "[TODO] The web service Operation Description", + "properties": { + "name": { + "type": "string", + "description": "The operation name" + }, + "display": { + "type": "object", + "description": "[TODO] Display", + "properties": { + "provider": { + "type": "string", + "description": "[TODO] Provider", + "default": "Machine Learning" + }, + "resource": { + "type": "string", + "description": "[TODO] Resource", + "default": "web service" + }, + "operation": { + "type": "string", + "description": "[TODO] Operation" + }, + "description": { + "type": "string", + "description": "[TODO] Description" + } } + }, + "origin": { + "type": "string", + "description": "[TODO] Origin", + "enum": [ + "user", + "system", + "user, system" + ] } - }, - "origin": { - "type": "string", - "description": "[TODO] Origin", - "enum": [ - "user", - "system", - "user, system" - ] } } } - } } \ No newline at end of file From 067680e4faa391414465ce412a13d9afdccbee07 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Fri, 15 Apr 2016 11:32:44 -0700 Subject: [PATCH 12/18] Add potential 204 response code on delete when resource does not exist --- .../2016-04-01-privatepreview/swagger/webservices.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index 5c4d43ccb11b..d75a2d5f527f 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -103,6 +103,9 @@ "responses": { "202": { "description": "Async delete operation was accepted." + }, + "204": { + "description": "No Content" } }, "x-ms-long-running-operation": true From 4564cd47ad0bbd677a10386a81b8d2a9499d61c7 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Fri, 15 Apr 2016 16:15:10 -0700 Subject: [PATCH 13/18] Changes to swagger spec to reflect sevice changes: - added title property to web service - changed API path for get keys API - changed StorageAccount details contract - renamed preview spec and updated to latest form in preparation to preview release --- .../swagger/webservices.json | 950 ------------------ .../swagger/webservices.json | 18 +- .../swagger/webservices.json | 912 +++++++++++++++++ 3 files changed, 921 insertions(+), 959 deletions(-) delete mode 100644 arm-machinelearning/2016-04-01-preview/swagger/webservices.json create mode 100644 arm-machinelearning/2016-05-01-preview/swagger/webservices.json diff --git a/arm-machinelearning/2016-04-01-preview/swagger/webservices.json b/arm-machinelearning/2016-04-01-preview/swagger/webservices.json deleted file mode 100644 index 7722d8682626..000000000000 --- a/arm-machinelearning/2016-04-01-preview/swagger/webservices.json +++ /dev/null @@ -1,950 +0,0 @@ -{ - "swagger": "2.0", - "host": "management.azure.com", - "info": { - "title": "Machine Learning Web Services Management Client APIs", - "description": "These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:
  • Create a Web Service
  • Get a Web Service
  • Patch a Web Service
  • Delete a Web Service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
  • Check Name Availability
  • Get All Available Operations
", - "version": "2016-04-01-preview" - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { - "put": { - "operationId": "CreateOrUpdateWebService", - "description": "Create a new Web Service or update an existing one.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/CreateOrUpdateWebServiceRequestPayloadSchema" - } - ], - "responses": { - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/WebService" - } - } - } - }, - "get": { - "operationId": "GetWebService", - "description": "Retrieve a Web Service information by its name", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebService" - } - } - } - }, - "patch": { - "operationId": "PatchWebService", - "description": "Patch an existing Web Service", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/PatchWebServiceRequestPayloadSchema" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebService" - } - } - } - }, - "delete": { - "operationId": "DeleteWebService", - "description": "Delete an existing Web Service", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No-Content. The Web Service is not found." - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { - "get": { - "operationId": "GetWebServiceKeys", - "description": "Get the primary and secondary keys of a particular Web Service", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WebServiceNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebServiceKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { - "get": { - "operationId": "GetWebServicesInResourceGroup", - "description": "Retrieve all Web Services' information in a given Resource Group", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "The list of Web Services", - "items": { - "$ref": "#/definitions/WebService" - } - }, - "nextLink": { - "type": "string", - "description": "[TODO] Next Link" - } - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { - "get": { - "operationId": "GetWebServicesInSubscription", - "description": "Get all Web Services' information in current Azure subscription", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "List of Web Services", - "items": { - "$ref": "#/definitions/WebService" - } - }, - "nextLink": { - "type": "string", - "description": "[TODO] Next Link" - } - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft/MachineLearning/checkNameAvailability": { - "post": { - "operationId": "CheckNameAvaliability", - "description": "Check the Web Service Name is valid and not in use", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "$ref": "#/parameters/CheckNameAvailabilitySchema" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CheckNameResult" - } - } - } - } - }, - "/providers/Microsoft.MachineLearning/operations": { - "get": { - "operationId": "GetOperations", - "description": "Get all available operations of a Web Service", - "parameters": [ - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "List of Operations", - "items": { - "$ref": "#/definitions/OperationSchema" - } - } - } - } - } - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "in": "path", - "type": "string", - "required": true - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "description": "The name of the resource group within the user's subscription.", - "in": "path", - "type": "string", - "required": true - }, - "WebServiceNameParameter": { - "name": "webServiceName", - "description": "The Web Service name which you want to reach.", - "in": "path", - "type": "string", - "required": true - }, - "APIVersionParameter": { - "in": "query", - "name": "api-version", - "type": "string", - "description": "Client Api Version.", - "required": true, - "enum": [ "2016-02-01-preview" ] - }, - "CreateOrUpdateWebServiceRequestPayloadSchema": { - "in": "body", - "name": "createOrUpdatePayload", - "description": "The payload to create or update a Web Service", - "required": true, - "schema": { - "$ref": "#/definitions/WebService" - } - }, - "PatchWebServiceRequestPayloadSchema": { - "in": "body", - "name": "patchPayload", - "description": "[TODO] Patch Web Service Request Payload. It indicates all fields could be pacthed.", - "required": true, - "schema": { - "type": "object", - "title": "patchPayload", - "properties": { - "tags": { - "$ref": "#/definitions/Tags" - }, - "properties": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the Web Service" - }, - "keys": { - "$ref": "#/definitions/WebServiceKeys" - }, - "realtimeConfiguration": { - "$ref": "#/definitions/RealtimeConfiguration" - }, - "diagnostics": { - "$ref": "#/definitions/Diagnostics" - } - } - }, - "sku": { - "type": "object", - "description": "[TODO] SKU", - "properties": { - "name": { - "type": "string", - "description": "[TODO] Name" - }, - "tier": { - "type": "string", - "description": "[TODO] Tier" - } - } - } - } - } - }, - "CheckNameAvailabilitySchema": { - "in": "body", - "name": "checkNameAvailabilityPayload", - "description": "The payload to check name availability", - "required": true, - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The Web Service Name" - }, - "type": { - "type": "string", - "description": "The Web Service Type" - } - } - } - } - }, - "definitions": { - "WebService": { - "type": "object", - "title": "[TODO] The Web Service Object", - "properties": { - "location": { - "type": "string", - "description": "The Azure region where the web service is deployed." - }, - "tags": { - "$ref": "#/definitions/Tags" - }, - "properties": { - "$ref": "#/definitions/WebServiceProperties" - } - } - }, - "WebServiceProperties": { - "type": "object", - "description": "The definition of the web service being deployed.", - "required": [ - "packageType" - ], - "discriminator": "packageType", - "properties": { - "description": { - "type": "string", - "description": "The description the Web Service" - }, - "keys": { - "$ref": "#/definitions/WebServiceKeys" - }, - "operationModes": { - "type": "array", - "description": "[TODO] Operation Modes", - "items": { - "type": "string", - "description": "[TODO] Operation Mode" - } - }, - "realtimeConfiguration": { - "$ref": "#/definitions/RealtimeConfiguration" - }, - "batchConfiguration": { - "$ref": "#/definitions/BatchConfiguration" - }, - "readOnly": { - "type": "boolean", - "description": "True, if the Web Service should be read-only; False, otherwise" - }, - "diagnostics": { - "$ref": "#/definitions/Diagnostics" - }, - "storageAccount": { - "$ref": "#/definitions/StorageAccount" - }, - "machineLearningWorkspace": { - "$ref": "#/definitions/MachineLearningWorkspace" - }, - "input": { - "$ref": "#/definitions/ModuleInterface" - }, - "output": { - "$ref": "#/definitions/ModuleInterface" - }, - "assets": { - "$ref": "#/definitions/AssetProperties" - }, - "parameters": { - "type": "object", - "description": "[TODO] Parameters of module package", - "additionalProperties": { - "type": "string" - } - }, - "packageType": { - "type": "string", - "description": "[TODO] Module package type", - "enum": [ - "Code", - "Graph" - ] - } - } - }, - "WebServicePropertiesForGraph": { - "description": "[TODO] Payload for Graph package", - "x-ms-discriminator-value": "Graph", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" - } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Graph Package", - "properties": { - "nodes": { - "type": "object", - "description": "[TODO] Graph nodes collection", - "additionalProperties": { - "$ref": "#/definitions/GraphNode" - } - }, - "edges": { - "type": "array", - "description": "[TODO] List of Graph Edges", - "items": { - "$ref": "#/definitions/GraphEdge" - } - }, - "graphParameters": { - "type": "object", - "description": "[TODO] Graph parameter collection", - "additionalProperties": { - "$ref": "#/definitions/GraphParameter" - } - } - } - } - } - }, - "WebServicePropertiesForCode": { - "description": "[TODO] Payload for Code package", - "x-ms-discriminator-value": "Code", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" - } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Code Package", - "properties": { - "language": { - "type": "string", - "description": "[TODO] The language of source code", - "enum": [ - "Python-2.7", - "R-3.1" - ] - }, - "sourceCode": { - "type": "string", - "description": "[TODO] The source code" - }, - "zipFileAssetId": { - "type": "string", - "description": "[TODO] Zip file's Asset ID" - } - } - } - } - }, - "GraphNode": { - "type": "object", - "description": "[TODO] Graph Node", - "properties": { - "assetId": { - "type": "string", - "description": "[TODO] Asset ID" - }, - "inputId": { - "type": "string", - "description": "[TODO] Input ID" - }, - "outputId": { - "type": "string", - "description": "[TODO] Output ID" - }, - "parameters": { - "type": "object", - "description": "[TODO] Node Parameters", - "additionalProperties": { - "type": "string" - } - } - } - }, - "GraphEdge": { - "type": "object", - "description": "[TODO] Graph edge", - "properties": { - "sourceNode": { - "type": "string", - "description": "[TODO] Edge source" - }, - "sourceOutputPort": { - "type": "string", - "description": "[TODO] Source node output port" - }, - "targetNode": { - "type": "string", - "description": "[TODO] Edge target" - }, - "targetInputPort": { - "type": "string", - "description": "[TODO] Target node input port" - } - } - }, - "GraphParameter": { - "type": "object", - "description": "[TODO] Graph Parameter", - "properties": { - "description": { - "type": "string", - "description": "[TODO] Description of this Graph parameter" - }, - "defaultValue": { - "type": "string", - "description": "[TODO] The default value of this parameter. Could be null" - }, - "links": { - "type": "array", - "description": "[TODO] Links of this parameter", - "items": { - "$ref": "#/definitions/GraphParameterLink" - } - } - } - }, - "GraphParameterLink": { - "type": "object", - "description": "[TODO] The link in Graph Paramter", - "properties": { - "nodeId": { - "type": "string", - "description": "[TODO] The node ID" - }, - "parameterId": { - "type": "string", - "description": "[TODO] The parameter ID" - } - } - }, - "OperationSchema": { - "type": "object", - "description": "[TODO] The Web Service Operation Description", - "properties": { - "name": { - "type": "string", - "description": "The operation name" - }, - "display": { - "type": "object", - "description": "[TODO] Display", - "properties": { - "provider": { - "type": "string", - "description": "[TODO] Provider", - "default": "Machine Learning" - }, - "resource": { - "type": "string", - "description": "[TODO] Resource", - "default": "Web Service" - }, - "operation": { - "type": "string", - "description": "[TODO] Operation" - }, - "description": { - "type": "string", - "description": "[TODO] Description" - } - } - }, - "origin": { - "type": "string", - "description": "[TODO] Origin", - "enum": [ - "user", - "system", - "user, system" - ] - } - } - }, - "Tags": { - "type": "object", - "description": "The tags associated with this web service.", - "properties": { - "Experiement Location": { - "type": "string", - "description": "[TODO] Experiement Run Location" - } - } - }, - "RealtimeConfiguration": { - "type": "object", - "description": "Configuration settings for RRS", - "properties": { - "maxConcurrentCalls": { - "type": "integer", - "description": "[TODO] Max Concurrent Calls" - }, - "maxMemoryInMB": { - "type": "integer", - "description": "[TODO] Max Memory in MB" - }, - "maxDurationInSeconds": { - "type": "integer", - "description": "[TODO] Max Duration in Seconds" - } - } - }, - "BatchConfiguration": { - "type": "object", - "description": "[TODO] Batch Configuration", - "properties": { - "JobDriver": { - "type": "string", - "description": "[TODO] version, optional, etc." - }, - "Cluster": { - "$ref": "#/definitions/ClusterDefinition" - } - } - }, - "ClusterDefinition": { - "type": "object", - "description": "[TODO] Properties of GraphSharp", - "properties": { - "id": { - "type": "string", - "description": "ARM HDI cluster ID" - } - } - }, - "Diagnostics": { - "type": "object", - "description": "The Diagnostics Settings", - "properties": { - "level": { - "type": "string", - "description": "Trace Level: None, Error, All" - }, - "expiry": { - "type": "string", - "description": "[TODO] Expiry" - } - } - }, - "StorageAccount": { - "type": "object", - "description": "[TODO] The Storage Account used in GraphSharp", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The Storage Account ID" - } - } - }, - "MachineLearningWorkspace": { - "type": "object", - "description": "[TODO] The Machine Learning Workspace", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The Workspace ID" - } - } - }, - "WebServiceKeys": { - "type": "object", - "description": "Web Service Keys", - "properties": { - "prmiary": { - "type": "string", - "description": "The Primary Key" - }, - "secondary": { - "type": "string", - "description": "The Secondary Key" - } - } - }, - "CheckNameResult": { - "type": "object", - "properties": { - "nameAvaliable": { - "type": "boolean", - "description": "True, if the name is available; False, otherwise" - }, - "reason": { - "type": "string", - "description": "The reason why if it is not available", - "enum": [ - "Invalid", - "AlreadyExists" - ] - }, - "message": { - "type": "string", - "description": ": The message from the server" - } - } - }, - "ModuleInterface": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Interface Title" - }, - "description": { - "type": "string", - "description": "[TODO] Description of the Interface" - }, - "type": { - "type": "string", - "description": "[TODO] Interface properties' type. Always use 'object' here.", - "default": "object" - }, - "properties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AfxDataTable" - } - } - } - }, - "AssetProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetItem" - } - }, - "AfxDataTable": { - "type": "object", - "description": "[TODO] Afx data table", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Table title" - }, - "description": { - "type": "string", - "description": "[TODO] Table description" - }, - "type": { - "type": "string", - "description": "[TODO] Table properties' type. Always use 'object' here.", - "default": "object" - }, - "properties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AfxDataTableColumn" - } - } - } - }, - "AfxDataTableColumn": { - "type": "object", - "description": "[TODO] Afx data table column", - "properties": { - "type": { - "type": "string", - "description": "[TODO] Data type" - }, - "format": { - "type": "string", - "description": "[TODO] Data format" - }, - "enum": { - "type": "array", - "description": "[TODO] Options", - "items": { - "$ref": "#/definitions/AfxDataTableColumnEnum" - } - }, - "x-ms-isnullable": { - "type": "boolean", - "description": "[TODO] Is nullable" - }, - "x-ms-isordered": { - "type": "boolean", - "description": "[TODO] Is enum in order" - } - } - }, - "AfxDataTableColumnEnum": { - "type": "string", - "description": "[TODO] Enum item" - }, - "AssetItem": { - "type": "object", - "description": "[TODO] Asset Name", - "properties": { - "name": { - "type": "string", - "description": "Module friendly name" - }, - "type": { - "type": "string", - "description": "Module type", - "default": "module" - }, - "location": { - "$ref": "#/definitions/AssetLocation" - }, - "inputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetPort" - } - }, - "outputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetPort" - } - }, - "metadata": { - "$ref": "#/definitions/AssetMetaData" - } - } - }, - "AssetLocation": { - "type": "object", - "description": "[TODO] Asset Location", - "properties": { - "uri": { - "type": "string", - "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", - "format": "url" - }, - "credentials": { - "type": "string", - "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." - } - } - }, - "AssetPort": { - "type": "object", - "description": "[TODO] Asset Port", - "properties": { - "type": { - "type": "string", - "description": "[TODO] dataset or zip" - } - } - }, - "AssetMetaData": { - "type": "object", - "description": "[TODO] Asset Meta Data", - "additionalProperties": { - "type": "string", - "description": "[TODO] Meta data value" - } - } - } -} diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index d75a2d5f527f..465ea7ae241f 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -133,7 +133,7 @@ } ] }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/keys": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/listKeys": { "get": { "tags": [ "WebServices" @@ -311,9 +311,13 @@ ], "discriminator": "packageType", "properties": { + "title": { + "type": "string", + "description": "The title the Azure ML web service." + }, "description": { "type": "string", - "description": "The description the Azure ML web service" + "description": "The description the Azure ML web service." }, "createdOn": { "type": "string", @@ -553,14 +557,10 @@ "type": "string", "description": "[TODO] The storage account's name" }, - "primaryKey": { + "key": { "type": "string", - "description": "[TODO] The storage account's primary key" - }, - "secondaryKey": { - "type": "string", - "description": "[TODO] The storage account's secondary key" - } + "description": "[TODO] The storage account's active key" + } } }, "MachineLearningWorkspace": { diff --git a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json new file mode 100644 index 000000000000..99a4d2692755 --- /dev/null +++ b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json @@ -0,0 +1,912 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureML Web Services Management Client", + "description": "[TODO] These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:
  • Create a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
  • Get All Available Operations
", + "version": "2016-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { + "put": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_CreateOrUpdateWebService", + "description": "Create a new Azure ML web service or update an existing one.", + "parameters": [ + { + "in": "body", + "name": "createOrUpdatePayload", + "description": "The payload to create or update the Azure ML web service.", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WebService" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebService", + "description": "Retrieve an Azure ML web service definition by its subscription, resource group and name.", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + } + }, + "patch": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_PatchWebService", + "description": "Patch an existing Azure ML web service.", + "parameters": [ + { + "in": "body", + "name": "patchPayload", + "description": "The payload to patch the Azure ML with.", + "required": true, + "schema": { + "$ref": "#/definitions/WebService" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebService" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_RemoveWebService", + "description": "Remove an existing Azure ML web service.", + "responses": { + "202": { + "description": "Async delete operation was accepted." + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "webServiceName", + "description": "The Azure ML web service name which you want to reach.", + "in": "path", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ] + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/listKeys": { + "get": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServiceKeys", + "description": "Get the primary and secondary access keys of a particular Azure ML web service", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true + }, + { + "name": "webServiceName", + "description": "The Azure ML web service name which you want to reach.", + "in": "path", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WebServiceKeys" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServicesInResourceGroup", + "description": "Retrieve all Azure ML web services in a given resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group.", + "in": "path", + "type": "string", + "required": true + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebServicesList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { + "get": { + "tags": [ + "WebServices" + ], + "operationId": "WebServices_GetWebServicesInSubscription", + "description": "Retrieve all Azure ML web services in the current Azure subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PaginatedWebServicesList" + } + } + } + } + }, + "/providers/Microsoft.MachineLearning/operations": { + "get": { + "operationId": "GetOperations", + "description": "Get all available operations for the Microsoft.MachineLearning provider.", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Operations", + "items": { + "$ref": "#/definitions/OperationSchema" + } + } + } + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Azure subscription id.", + "in": "path", + "type": "string", + "required": true + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "The versiong of the Microsoft.MachineLearning resource provider API to be used.", + "required": true + } + }, + "definitions": { + "WebService": { + "type": "object", + "title": "[TODO] Instance of an Azure ML web service resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebServiceProperties" + } + } + }, + "WebServiceProperties": { + "type": "object", + "description": "The set of properties specific to the Azure ML web service resource.", + "required": [ + "packageType" + ], + "discriminator": "packageType", + "properties": { + "title": { + "type": "string", + "description": "The title the Azure ML web service." + }, + "description": { + "type": "string", + "description": "The description the Azure ML web service." + }, + "createdOn": { + "type": "string", + "description": "The moment of time the Azure ML web service was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "type": "string", + "description": "The moment of time the web service was last modified.", + "format": "date-time", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "The web service resource's provisioning state.", + "enum": [ + "Unknown", + "Provisioning", + "Succeeded", + "Failed", + "Canceled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys" + }, + "readOnly": { + "type": "boolean", + "description": "True, if the web service should be read-only; False, otherwise" + }, + "swaggerLocation": { + "type": "string", + "description": "The uri for the swagger spec associated with this Azure ML web service.", + "readOnly": true + }, + "realtimeConfiguration": { + "description": "[TODO] Realtime configuration", + "$ref": "#/definitions/RealtimeConfiguration" + }, + "diagnostics": { + "description": "[TODO] Diagnostics settings", + "$ref": "#/definitions/DiagnosticsConfiguration" + }, + "storageAccount": { + "description": "[TODO] BYOS description", + "$ref": "#/definitions/StorageAccount" + }, + "machineLearningWorkspace": { + "description": "[TODO] Service workspace data", + "$ref": "#/definitions/MachineLearningWorkspace" + }, + "commitmentPlan": { + "description": "[TODO] Service commitment plan data", + "$ref": "#/definitions/CommitmentPlan" + }, + "input": { + "description": "[TODO] Service input definition", + "$ref": "#/definitions/ServiceInputOutputSpecification" + }, + "output": { + "description": "[TODO] Service output definition", + "$ref": "#/definitions/ServiceInputOutputSpecification" + }, + "assets": { + "description": "[TODO] Service assets", + "$ref": "#/definitions/AssetProperties" + }, + "parameters": { + "type": "object", + "description": "[TODO] Parameters of module package", + "additionalProperties": { + "type": "string" + } + }, + "packageType": { + "type": "string", + "description": "[TODO] Module package type", + "enum": [ + "Code", + "Graph" + ], + "readOnly": true, + "x-ms-enum": { + "name": "PackageType", + "modelAsString": false + } + } + } + }, + "WebServicePropertiesForGraph": { + "description": "[TODO] Payload for Graph package", + "x-ms-discriminator-value": "Graph", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Graph Package", + "properties": { + "nodes": { + "type": "object", + "description": "[TODO] Graph nodes collection", + "additionalProperties": { + "$ref": "#/definitions/GraphNode" + } + }, + "edges": { + "type": "array", + "description": "[TODO] List of Graph Edges", + "items": { + "$ref": "#/definitions/GraphEdge" + } + }, + "graphParameters": { + "type": "object", + "description": "[TODO] Graph parameter collection", + "additionalProperties": { + "$ref": "#/definitions/GraphParameter" + } + } + } + } + } + }, + "WebServicePropertiesForCode": { + "description": "[TODO] Payload for Code package", + "x-ms-discriminator-value": "Code", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Code Package", + "properties": { + "language": { + "type": "string", + "description": "[TODO] The language of source code", + "enum": [ + "Python-2.7", + "R-3.1" + ] + }, + "sourceCode": { + "type": "string", + "description": "[TODO] The source code" + }, + "zipFileAssetId": { + "type": "string", + "description": "[TODO] Zip file's Asset ID" + } + } + } + } + }, + "WebServiceKeys": { + "type": "object", + "description": "web service Keys", + "properties": { + "primary": { + "type": "string", + "description": "The Primary Key" + }, + "secondary": { + "type": "string", + "description": "The Secondary Key" + } + } + }, + "PaginatedWebServicesList": { + "type": "object", + "description": "[TODO] Paginated list of web services", + "properties": { + "value": { + "type": "array", + "description": "List of Web Services", + "items": { + "$ref": "#/definitions/WebService" + } + }, + "nextLink": { + "type": "string", + "description": "[TODO] Next Link" + } + } + }, + "RealtimeConfiguration": { + "type": "object", + "description": "Configuration settings for RRS", + "properties": { + "maxConcurrentCalls": { + "type": "integer", + "description": "[TODO] Max Concurrent Calls" + } + } + }, + "DiagnosticsConfiguration": { + "type": "object", + "description": "The Diagnostics Settings", + "properties": { + "level": { + "type": "string", + "description": "Trace Level: None, Error, All", + "enum": [ + "None", + "Error", + "All" + ], + "x-ms-enum": { + "name": "DiagnosticsLevel", + "modelAsString": false + } + }, + "expiry": { + "type": "string", + "description": "[TODO] Expiry date", + "format": "date-time" + } + } + }, + "StorageAccount": { + "type": "object", + "description": "[TODO] The Storage Account used in GraphSharp", + "properties": { + "name": { + "type": "string", + "description": "[TODO] The storage account's name" + }, + "key": { + "type": "string", + "description": "[TODO] The storage account's active key" + } + } + }, + "MachineLearningWorkspace": { + "type": "object", + "description": "[TODO] The machine learning workspace", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The Workspace ID" + } + } + }, + "CommitmentPlan": { + "type": "object", + "description": "[TODO] The commitment plan associated with this web service", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The plan's ID" + } + } + }, + "ServiceInputOutputSpecification": { + "type": "object", + "description": "[TODO] The swagger schema describing the service's input.", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Interface title" + }, + "description": { + "type": "string", + "description": "[TODO] Description of the interface" + }, + "type": { + "type": "string", + "description": "[TODO] Interface properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "object", + "description": "[TODO]", + "additionalProperties": { + "$ref": "#/definitions/TableSpecification" + } + } + } + }, + "TableSpecification": { + "type": "object", + "description": "[TODO] schema for a data table", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Table title" + }, + "description": { + "type": "string", + "description": "[TODO] Table description" + }, + "type": { + "type": "string", + "description": "[TODO] Table properties' type. Always use 'object' here.", + "default": "object" + }, + "properties": { + "type": "object", + "description": "The set of columns within the data table", + "additionalProperties": { + "$ref": "#/definitions/ColumnSpecification" + } + } + } + }, + "ColumnSpecification": { + "type": "object", + "description": "[TODO] input column.", + "properties": { + "type": { + "type": "string", + "description": "[TODO] Data type" + }, + "format": { + "type": "string", + "description": "[TODO] Data format" + }, + "enum": { + "type": "array", + "description": "[TODO] Options", + "items": { + "type": "object" + } + }, + "x-ms-isnullable": { + "type": "boolean", + "description": "[TODO] Is nullable" + }, + "x-ms-isordered": { + "type": "boolean", + "description": "[TODO] Is enum in order" + } + } + }, + "AssetProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetItem" + } + }, + "AssetItem": { + "type": "object", + "description": "[TODO] Service asset details", + "properties": { + "name": { + "type": "string", + "description": "Module friendly name" + }, + "type": { + "type": "string", + "description": "Module type", + "default": "module" + }, + "location": { + "$ref": "#/definitions/AssetLocation" + }, + "inputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/InputPort" + } + }, + "outputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/OutputPort" + } + } + } + }, + "AssetLocation": { + "type": "object", + "description": "[TODO] Asset Location", + "properties": { + "uri": { + "type": "string", + "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", + "format": "url" + }, + "credentials": { + "type": "string", + "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." + } + } + }, + "InputPort": { + "type": "object", + "description": "[TODO] Asset input port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" + } + } + }, + "OutputPort": { + "type": "object", + "description": "[TODO] Asset output port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" + } + } + }, + "GraphNode": { + "type": "object", + "description": "[TODO] Graph Node", + "properties": { + "assetId": { + "type": "string", + "description": "[TODO] Asset ID" + }, + "inputId": { + "type": "string", + "description": "[TODO] Input ID" + }, + "outputId": { + "type": "string", + "description": "[TODO] Output ID" + }, + "parameters": { + "type": "object", + "description": "[TODO] Node Parameters", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GraphEdge": { + "type": "object", + "description": "[TODO] Graph edge", + "properties": { + "sourceNodeId": { + "type": "string", + "description": "[TODO] Edge source" + }, + "sourcePortId": { + "type": "string", + "description": "[TODO] Source node output port id" + }, + "targetNodeId": { + "type": "string", + "description": "[TODO] Edge target" + }, + "targetPortId": { + "type": "string", + "description": "[TODO] Target node input port id" + } + } + }, + "GraphParameter": { + "type": "object", + "description": "[TODO] Graph Parameters", + "properties": { + "description": { + "type": "string", + "description": "Description for this graph parameter." + }, + "type": { + "type": "string", + "description": "Graph parameter's type.", + "enum": [ + "String", + "Int", + "Float", + "Enumerated", + "Script", + "Mode", + "Credential", + "Boolean", + "Double", + "ColumnPicker", + "ParameterRange", + "DataGatewayName" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": false + } + }, + "links": { + "type": "array", + "description": "[TODO] Links of this parameter", + "items": { + "$ref": "#/definitions/GraphParameterLink" + } + } + } + }, + "GraphParameterLink": { + "type": "object", + "description": "[TODO] The link in graph parameter", + "properties": { + "nodeId": { + "type": "string", + "description": "[TODO] The node ID" + }, + "parameterKey": { + "type": "string", + "description": "[TODO] The parameter key" + } + } + }, + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "description": "Resource Id", + "type": "string" + }, + "name": { + "description": "Resource Name", + "type": "string" + }, + "location": { + "description": "Resource Location", + "type": "string" + }, + "type": { + "description": "Resource type", + "type": "string" + }, + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OperationSchema": { + "type": "object", + "description": "[TODO] The web service Operation Description", + "properties": { + "name": { + "type": "string", + "description": "The operation name" + }, + "display": { + "type": "object", + "description": "[TODO] Display", + "properties": { + "provider": { + "type": "string", + "description": "[TODO] Provider", + "default": "Machine Learning" + }, + "resource": { + "type": "string", + "description": "[TODO] Resource", + "default": "web service" + }, + "operation": { + "type": "string", + "description": "[TODO] Operation" + }, + "description": { + "type": "string", + "description": "[TODO] Description" + } + } + }, + "origin": { + "type": "string", + "description": "[TODO] Origin", + "enum": [ + "user", + "system", + "user, system" + ] + } + } + } + } +} \ No newline at end of file From 9d8a79dc9882210ef04f68490255334ff594d65f Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Wed, 20 Apr 2016 11:49:23 -0700 Subject: [PATCH 14/18] added metadata and parameters properties to the asset contract to support custom modules --- .../swagger/webservices.json | 1190 +++++++++-------- 1 file changed, 621 insertions(+), 569 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index 465ea7ae241f..b5c6f0e33334 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -289,624 +289,676 @@ } }, "definitions": { - "WebService": { - "type": "object", - "title": "[TODO] Instance of an Azure ML web service resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/WebServiceProperties" - } + "WebService": { + "type": "object", + "title": "[TODO] Instance of an Azure ML web service resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" } - }, - "WebServiceProperties": { - "type": "object", - "description": "The set of properties specific to the Azure ML web service resource.", - "required": [ - "packageType" - ], - "discriminator": "packageType", + ], + "properties": { "properties": { - "title": { - "type": "string", - "description": "The title the Azure ML web service." - }, - "description": { - "type": "string", - "description": "The description the Azure ML web service." - }, - "createdOn": { - "type": "string", - "description": "The moment of time the Azure ML web service was created.", - "format": "date-time", - "readOnly": true - }, - "modifiedOn": { - "type": "string", - "description": "The moment of time the web service was last modified.", - "format": "date-time", - "readOnly": true - }, - "provisioningState": { - "type": "string", - "description": "The web service resource's provisioning state.", - "enum": [ - "Unknown", - "Provisioning", - "Succeeded", - "Failed", - "Canceled" - ], - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "keys": { - "$ref": "#/definitions/WebServiceKeys" - }, - "readOnly": { - "type": "boolean", - "description": "True, if the web service should be read-only; False, otherwise" - }, - "swaggerLocation": { - "type": "string", - "description": "The uri for the swagger spec associated with this Azure ML web service.", - "readOnly": true - }, - "realtimeConfiguration": { - "description": "[TODO] Realtime configuration", - "$ref": "#/definitions/RealtimeConfiguration" - }, - "diagnostics": { - "description": "[TODO] Diagnostics settings", - "$ref": "#/definitions/DiagnosticsConfiguration" - }, - "storageAccount": { - "description": "[TODO] BYOS description", - "$ref": "#/definitions/StorageAccount" - }, - "machineLearningWorkspace": { - "description": "[TODO] Service workspace data", - "$ref": "#/definitions/MachineLearningWorkspace" - }, - "commitmentPlan": { - "description": "[TODO] Service commitment plan data", - "$ref": "#/definitions/CommitmentPlan" - }, - "input": { - "description": "[TODO] Service input definition", - "$ref": "#/definitions/ServiceInputOutputSpecification" - }, - "output": { - "description": "[TODO] Service output definition", - "$ref": "#/definitions/ServiceInputOutputSpecification" - }, - "assets": { - "description": "[TODO] Service assets", - "$ref": "#/definitions/AssetProperties" - }, - "parameters": { - "type": "object", - "description": "[TODO] Parameters of module package", - "additionalProperties": { - "type": "string" - } - }, - "packageType": { - "type": "string", - "description": "[TODO] Module package type", - "enum": [ - "Code", - "Graph" - ], - "readOnly": true, - "x-ms-enum": { - "name": "PackageType", - "modelAsString": false - } - } + "$ref": "#/definitions/WebServiceProperties" } - }, - "WebServicePropertiesForGraph": { - "description": "[TODO] Payload for Graph package", - "x-ms-discriminator-value": "Graph", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" + } + }, + "WebServiceProperties": { + "type": "object", + "description": "The set of properties specific to the Azure ML web service resource.", + "required": [ + "packageType" + ], + "discriminator": "packageType", + "properties": { + "title": { + "type": "string", + "description": "The title the Azure ML web service." + }, + "description": { + "type": "string", + "description": "The description the Azure ML web service." + }, + "createdOn": { + "type": "string", + "description": "The moment of time the Azure ML web service was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "type": "string", + "description": "The moment of time the web service was last modified.", + "format": "date-time", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "The web service resource's provisioning state.", + "enum": [ + "Unknown", + "Provisioning", + "Succeeded", + "Failed", + "Canceled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Graph Package", - "properties": { - "nodes": { - "type": "object", - "description": "[TODO] Graph nodes collection", - "additionalProperties": { - "$ref": "#/definitions/GraphNode" - } - }, - "edges": { - "type": "array", - "description": "[TODO] List of Graph Edges", - "items": { - "$ref": "#/definitions/GraphEdge" - } - }, - "graphParameters": { - "type": "object", - "description": "[TODO] Graph parameter collection", - "additionalProperties": { - "$ref": "#/definitions/GraphParameter" - } - } - } + }, + "keys": { + "$ref": "#/definitions/WebServiceKeys" + }, + "readOnly": { + "type": "boolean", + "description": "True, if the web service should be read-only; False, otherwise" + }, + "swaggerLocation": { + "type": "string", + "description": "The uri for the swagger spec associated with this Azure ML web service.", + "readOnly": true + }, + "realtimeConfiguration": { + "description": "[TODO] Realtime configuration", + "$ref": "#/definitions/RealtimeConfiguration" + }, + "diagnostics": { + "description": "[TODO] Diagnostics settings", + "$ref": "#/definitions/DiagnosticsConfiguration" + }, + "storageAccount": { + "description": "[TODO] BYOS description", + "$ref": "#/definitions/StorageAccount" + }, + "machineLearningWorkspace": { + "description": "[TODO] Service workspace data", + "$ref": "#/definitions/MachineLearningWorkspace" + }, + "commitmentPlan": { + "description": "[TODO] Service commitment plan data", + "$ref": "#/definitions/CommitmentPlan" + }, + "input": { + "description": "[TODO] Service input definition", + "$ref": "#/definitions/ServiceInputOutputSpecification" + }, + "output": { + "description": "[TODO] Service output definition", + "$ref": "#/definitions/ServiceInputOutputSpecification" + }, + "assets": { + "description": "[TODO] Service assets", + "$ref": "#/definitions/AssetProperties" + }, + "parameters": { + "type": "object", + "description": "[TODO] Parameters of module package", + "additionalProperties": { + "type": "string" } - } - }, - "WebServicePropertiesForCode": { - "description": "[TODO] Payload for Code package", - "x-ms-discriminator-value": "Code", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" + }, + "packageType": { + "type": "string", + "description": "[TODO] Module package type", + "enum": [ + "Code", + "Graph" + ], + "readOnly": true, + "x-ms-enum": { + "name": "PackageType", + "modelAsString": false } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Code Package", - "properties": { - "language": { - "type": "string", - "description": "[TODO] The language of source code", - "enum": [ - "Python-2.7", - "R-3.1" - ] - }, - "sourceCode": { - "type": "string", - "description": "[TODO] The source code" - }, - "zipFileAssetId": { - "type": "string", - "description": "[TODO] Zip file's Asset ID" + } + } + }, + "WebServicePropertiesForGraph": { + "description": "[TODO] Payload for Graph package", + "x-ms-discriminator-value": "Graph", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" + } + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Graph Package", + "properties": { + "nodes": { + "type": "object", + "description": "[TODO] Graph nodes collection", + "additionalProperties": { + "$ref": "#/definitions/GraphNode" + } + }, + "edges": { + "type": "array", + "description": "[TODO] List of Graph Edges", + "items": { + "$ref": "#/definitions/GraphEdge" + } + }, + "graphParameters": { + "type": "object", + "description": "[TODO] Graph parameter collection", + "additionalProperties": { + "$ref": "#/definitions/GraphParameter" } } } } - }, - "WebServiceKeys": { - "type": "object", - "description": "web service Keys", - "properties": { - "primary": { - "type": "string", - "description": "The Primary Key" - }, - "secondary": { - "type": "string", - "description": "The Secondary Key" - } + } + }, + "WebServicePropertiesForCode": { + "description": "[TODO] Payload for Code package", + "x-ms-discriminator-value": "Code", + "allOf": [ + { + "$ref": "#/definitions/WebServiceProperties" } - }, - "PaginatedWebServicesList": { - "type": "object", - "description": "[TODO] Paginated list of web services", - "properties": { - "value": { - "type": "array", - "description": "List of Web Services", - "items": { - "$ref": "#/definitions/WebService" + ], + "properties": { + "package": { + "type": "object", + "description": "[TODO] Code Package", + "properties": { + "language": { + "type": "string", + "description": "[TODO] The language of source code", + "enum": [ + "Python-2.7", + "R-3.1" + ] + }, + "sourceCode": { + "type": "string", + "description": "[TODO] The source code" + }, + "zipFileAssetId": { + "type": "string", + "description": "[TODO] Zip file's Asset ID" } - }, - "nextLink": { - "type": "string", - "description": "[TODO] Next Link" } } - }, - "RealtimeConfiguration": { - "type": "object", - "description": "Configuration settings for RRS", - "properties": { - "maxConcurrentCalls": { - "type": "integer", - "description": "[TODO] Max Concurrent Calls" - } + } + }, + "WebServiceKeys": { + "type": "object", + "description": "web service Keys", + "properties": { + "primary": { + "type": "string", + "description": "The Primary Key" + }, + "secondary": { + "type": "string", + "description": "The Secondary Key" } - }, - "DiagnosticsConfiguration": { - "type": "object", - "description": "The Diagnostics Settings", - "properties": { - "level": { - "type": "string", - "description": "Trace Level: None, Error, All", - "enum": [ - "None", - "Error", - "All" - ], - "x-ms-enum": { - "name": "DiagnosticsLevel", - "modelAsString": false - } - }, - "expiry": { - "type": "string", - "description": "[TODO] Expiry date", - "format": "date-time" + } + }, + "PaginatedWebServicesList": { + "type": "object", + "description": "[TODO] Paginated list of web services", + "properties": { + "value": { + "type": "array", + "description": "List of Web Services", + "items": { + "$ref": "#/definitions/WebService" } + }, + "nextLink": { + "type": "string", + "description": "[TODO] Next Link" } - }, - "StorageAccount": { - "type": "object", - "description": "[TODO] The Storage Account used in GraphSharp", - "properties": { - "name": { - "type": "string", - "description": "[TODO] The storage account's name" - }, - "key": { - "type": "string", - "description": "[TODO] The storage account's active key" - } + } + }, + "RealtimeConfiguration": { + "type": "object", + "description": "Configuration settings for RRS", + "properties": { + "maxConcurrentCalls": { + "type": "integer", + "description": "[TODO] Max Concurrent Calls" } - }, - "MachineLearningWorkspace": { - "type": "object", - "description": "[TODO] The machine learning workspace", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The Workspace ID" + } + }, + "DiagnosticsConfiguration": { + "type": "object", + "description": "The Diagnostics Settings", + "properties": { + "level": { + "type": "string", + "description": "Trace Level: None, Error, All", + "enum": [ + "None", + "Error", + "All" + ], + "x-ms-enum": { + "name": "DiagnosticsLevel", + "modelAsString": false } + }, + "expiry": { + "type": "string", + "description": "[TODO] Expiry date", + "format": "date-time" } - }, - "CommitmentPlan": { - "type": "object", - "description": "[TODO] The commitment plan associated with this web service", + } + }, + "StorageAccount": { + "type": "object", + "description": "[TODO] The Storage Account used in GraphSharp", + "properties": { + "name": { + "type": "string", + "description": "[TODO] The storage account's name" + }, + "key": { + "type": "string", + "description": "[TODO] The storage account's active key" + } + } + }, + "MachineLearningWorkspace": { + "type": "object", + "description": "[TODO] The machine learning workspace", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The Workspace ID" + } + } + }, + "CommitmentPlan": { + "type": "object", + "description": "[TODO] The commitment plan associated with this web service", + "properties": { + "id": { + "type": "string", + "description": "[TODO] The plan's ID" + } + } + }, + "ServiceInputOutputSpecification": { + "type": "object", + "description": "[TODO] The swagger schema describing the service's input.", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Interface title" + }, + "description": { + "type": "string", + "description": "[TODO] Description of the interface" + }, + "type": { + "type": "string", + "description": "[TODO] Interface properties' type. Always use 'object' here.", + "default": "object" + }, "properties": { - "id": { - "type": "string", - "description": "[TODO] The plan's ID" + "type": "object", + "description": "[TODO]", + "additionalProperties": { + "$ref": "#/definitions/TableSpecification" } } - }, - "ServiceInputOutputSpecification": { - "type": "object", - "description": "[TODO] The swagger schema describing the service's input.", + } + }, + "TableSpecification": { + "type": "object", + "description": "[TODO] schema for a data table", + "properties": { + "title": { + "type": "string", + "description": "[TODO] Table title" + }, + "description": { + "type": "string", + "description": "[TODO] Table description" + }, + "type": { + "type": "string", + "description": "[TODO] Table properties' type. Always use 'object' here.", + "default": "object" + }, "properties": { - "title": { - "type": "string", - "description": "[TODO] Interface title" - }, - "description": { - "type": "string", - "description": "[TODO] Description of the interface" - }, - "type": { - "type": "string", - "description": "[TODO] Interface properties' type. Always use 'object' here.", - "default": "object" - }, - "properties": { - "type": "object", - "description": "[TODO]", - "additionalProperties": { - "$ref": "#/definitions/TableSpecification" - } + "type": "object", + "description": "The set of columns within the data table", + "additionalProperties": { + "$ref": "#/definitions/ColumnSpecification" } } - }, - "TableSpecification": { - "type": "object", - "description": "[TODO] schema for a data table", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Table title" - }, - "description": { - "type": "string", - "description": "[TODO] Table description" - }, - "type": { - "type": "string", - "description": "[TODO] Table properties' type. Always use 'object' here.", - "default": "object" - }, - "properties": { - "type": "object", - "description": "The set of columns within the data table", - "additionalProperties": { - "$ref": "#/definitions/ColumnSpecification" - } + } + }, + "ColumnSpecification": { + "type": "object", + "description": "[TODO] input column.", + "properties": { + "type": { + "type": "string", + "description": "[TODO] Data type" + }, + "format": { + "type": "string", + "description": "[TODO] Data format" + }, + "enum": { + "type": "array", + "description": "[TODO] Options", + "items": { + "type": "object" } + }, + "x-ms-isnullable": { + "type": "boolean", + "description": "[TODO] Is nullable" + }, + "x-ms-isordered": { + "type": "boolean", + "description": "[TODO] Is enum in order" } - }, - "ColumnSpecification": { - "type": "object", - "description": "[TODO] input column.", - "properties": { - "type": { - "type": "string", - "description": "[TODO] Data type" - }, - "format": { - "type": "string", - "description": "[TODO] Data format" - }, - "enum": { - "type": "array", - "description": "[TODO] Options", - "items": { - "type": "object" - } - }, - "x-ms-isnullable": { - "type": "boolean", - "description": "[TODO] Is nullable" - }, - "x-ms-isordered": { - "type": "boolean", - "description": "[TODO] Is enum in order" + } + }, + "AssetProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AssetItem" + } + }, + "AssetItem": { + "type": "object", + "description": "[TODO] Service asset details", + "properties": { + "name": { + "type": "string", + "description": "Asset's friendly name" + }, + "type": { + "type": "string", + "description": "Asset's type", + "default": "module" + }, + "location": { + "$ref": "#/definitions/AssetLocation" + }, + "inputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/InputPort" + } + }, + "outputPorts": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/OutputPort" + } + }, + "metadata": { + "type": "object", + "description": "[TODO] Asset's metadata", + "additionalProperties": { + "type": "string" + } + }, + "parameters": { + "type": "array", + "description": "[TODO] Asset's parameters", + "items": { + "$ref": "#/definitions/ModuleAssetParameter" } } - }, - "AssetProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetItem" + } + }, + "AssetLocation": { + "type": "object", + "description": "[TODO] Asset Location", + "properties": { + "uri": { + "type": "string", + "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", + "format": "url" + }, + "credentials": { + "type": "string", + "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." } - }, - "AssetItem": { - "type": "object", - "description": "[TODO] Service asset details", - "properties": { - "name": { - "type": "string", - "description": "Module friendly name" - }, - "type": { - "type": "string", - "description": "Module type", - "default": "module" - }, - "location": { - "$ref": "#/definitions/AssetLocation" - }, - "inputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/InputPort" - } - }, - "outputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/OutputPort" - } + } + }, + "ModuleAssetParameter": { + "type": "object", + "description": "[TODO] Parameter for a custom module asset.", + "properties": { + "name": { + "type": "string", + "description": "Parameter name." + }, + "parameterType": { + "type": "string", + "description": "Parameter type." + }, + "modeValuesInfo": { + "type": "object", + "description": "[TODO] Add meaningful description here", + "additionalProperties": { + "$ref": "#/definitions/ModeValueInfo" } } - }, - "AssetLocation": { - "type": "object", - "description": "[TODO] Asset Location", - "properties": { - "uri": { - "type": "string", - "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", - "format": "url" - }, - "credentials": { - "type": "string", - "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." + } + }, + "ModeValueInfo": { + "type": "object", + "description": "[TODO] Add meaningful description here.", + "properties": { + "interfaceString": { + "type": "string", + "description": "[TODO] Add meaningful description here." + }, + "parameters": { + "type": "array", + "description": "[TODO] Add meaningful description here.", + "items": { + "$ref": "#/definitions/ModuleAssetParameter" } } - }, - "InputPort": { - "type": "object", - "description": "[TODO] Asset input port", - "properties": { - "type": { - "type": "string", - "description": "[TODO] dataset or zip" - } + } + }, + "InputPort": { + "type": "object", + "description": "[TODO] Asset input port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" } - }, - "OutputPort": { - "type": "object", - "description": "[TODO] Asset output port", - "properties": { - "type": { - "type": "string", - "description": "[TODO] dataset or zip" - } + } + }, + "OutputPort": { + "type": "object", + "description": "[TODO] Asset output port", + "properties": { + "type": { + "type": "string", + "description": "[TODO] dataset or zip" } - }, - "GraphNode": { - "type": "object", - "description": "[TODO] Graph Node", - "properties": { - "assetId": { - "type": "string", - "description": "[TODO] Asset ID" - }, - "inputId": { - "type": "string", - "description": "[TODO] Input ID" - }, - "outputId": { - "type": "string", - "description": "[TODO] Output ID" - }, - "parameters": { - "type": "object", - "description": "[TODO] Node Parameters", - "additionalProperties": { - "type": "string" - } + } + }, + "GraphNode": { + "type": "object", + "description": "[TODO] Graph Node", + "properties": { + "assetId": { + "type": "string", + "description": "[TODO] Asset ID" + }, + "inputId": { + "type": "string", + "description": "[TODO] Input ID" + }, + "outputId": { + "type": "string", + "description": "[TODO] Output ID" + }, + "parameters": { + "type": "object", + "description": "[TODO] Node Parameters", + "additionalProperties": { + "type": "string" } } - }, - "GraphEdge": { - "type": "object", - "description": "[TODO] Graph edge", - "properties": { - "sourceNodeId": { - "type": "string", - "description": "[TODO] Edge source" - }, - "sourcePortId": { - "type": "string", - "description": "[TODO] Source node output port id" - }, - "targetNodeId": { - "type": "string", - "description": "[TODO] Edge target" - }, - "targetPortId": { - "type": "string", - "description": "[TODO] Target node input port id" - } + } + }, + "GraphEdge": { + "type": "object", + "description": "[TODO] Graph edge", + "properties": { + "sourceNodeId": { + "type": "string", + "description": "[TODO] Edge source" + }, + "sourcePortId": { + "type": "string", + "description": "[TODO] Source node output port id" + }, + "targetNodeId": { + "type": "string", + "description": "[TODO] Edge target" + }, + "targetPortId": { + "type": "string", + "description": "[TODO] Target node input port id" } - }, - "GraphParameter": { - "type": "object", - "description": "[TODO] Graph Parameters", - "properties": { - "description": { - "type": "string", - "description": "Description for this graph parameter." - }, - "type": { - "type": "string", - "description": "Graph parameter's type.", - "enum": [ - "String", - "Int", - "Float", - "Enumerated", - "Script", - "Mode", - "Credential", - "Boolean", - "Double", - "ColumnPicker", - "ParameterRange", - "DataGatewayName" - ], - "x-ms-enum": { - "name": "ParameterType", - "modelAsString": false - } - }, - "links": { - "type": "array", - "description": "[TODO] Links of this parameter", - "items": { - "$ref": "#/definitions/GraphParameterLink" - } + } + }, + "GraphParameter": { + "type": "object", + "description": "[TODO] Graph Parameters", + "properties": { + "description": { + "type": "string", + "description": "Description for this graph parameter." + }, + "type": { + "type": "string", + "description": "Graph parameter's type.", + "enum": [ + "String", + "Int", + "Float", + "Enumerated", + "Script", + "Mode", + "Credential", + "Boolean", + "Double", + "ColumnPicker", + "ParameterRange", + "DataGatewayName" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": false } - } - }, - "GraphParameterLink": { - "type": "object", - "description": "[TODO] The link in graph parameter", - "properties": { - "nodeId": { - "type": "string", - "description": "[TODO] The node ID" - }, - "parameterKey": { - "type": "string", - "description": "[TODO] The parameter key" + }, + "links": { + "type": "array", + "description": "[TODO] Links of this parameter", + "items": { + "$ref": "#/definitions/GraphParameterLink" } } - }, - "Resource": { - "required": [ - "location" - ], - "properties": { - "id": { - "description": "Resource Id", - "type": "string" - }, - "name": { - "description": "Resource Name", - "type": "string" - }, - "location": { - "description": "Resource Location", - "type": "string" - }, - "type": { - "description": "Resource type", + } + }, + "GraphParameterLink": { + "type": "object", + "description": "[TODO] The link in graph parameter", + "properties": { + "nodeId": { + "type": "string", + "description": "[TODO] The node ID" + }, + "parameterKey": { + "type": "string", + "description": "[TODO] The parameter key" + } + } + }, + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "description": "Resource Id", + "type": "string" + }, + "name": { + "description": "Resource Name", + "type": "string" + }, + "location": { + "description": "Resource Location", + "type": "string" + }, + "type": { + "description": "Resource type", + "type": "string" + }, + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { "type": "string" - }, - "tags": { - "description": "Resource tags", - "type": "object", - "additionalProperties": { - "type": "string" - } } } - }, - "OperationSchema": { - "type": "object", - "description": "[TODO] The web service Operation Description", - "properties": { - "name": { - "type": "string", - "description": "The operation name" - }, - "display": { - "type": "object", - "description": "[TODO] Display", - "properties": { - "provider": { - "type": "string", - "description": "[TODO] Provider", - "default": "Machine Learning" - }, - "resource": { - "type": "string", - "description": "[TODO] Resource", - "default": "web service" - }, - "operation": { - "type": "string", - "description": "[TODO] Operation" - }, - "description": { - "type": "string", - "description": "[TODO] Description" - } + } + }, + "OperationSchema": { + "type": "object", + "description": "[TODO] The web service Operation Description", + "properties": { + "name": { + "type": "string", + "description": "The operation name" + }, + "display": { + "type": "object", + "description": "[TODO] Display", + "properties": { + "provider": { + "type": "string", + "description": "[TODO] Provider", + "default": "Machine Learning" + }, + "resource": { + "type": "string", + "description": "[TODO] Resource", + "default": "web service" + }, + "operation": { + "type": "string", + "description": "[TODO] Operation" + }, + "description": { + "type": "string", + "description": "[TODO] Description" } - }, - "origin": { - "type": "string", - "description": "[TODO] Origin", - "enum": [ - "user", - "system", - "user, system" - ] } + }, + "origin": { + "type": "string", + "description": "[TODO] Origin", + "enum": [ + "user", + "system", + "user, system" + ] } } } + } } \ No newline at end of file From d160c9e2592e488460fbe7420feffb21ec29889e Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Thu, 21 Apr 2016 10:27:00 -0700 Subject: [PATCH 15/18] porting changes to schema to the 2016-05-01 version also --- .../swagger/webservices.json | 56 ++++++++++++++++++- 1 file changed, 54 insertions(+), 2 deletions(-) diff --git a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json index 99a4d2692755..4ec7679e605e 100644 --- a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json +++ b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json @@ -676,11 +676,11 @@ "properties": { "name": { "type": "string", - "description": "Module friendly name" + "description": "Asset's friendly name" }, "type": { "type": "string", - "description": "Module type", + "description": "Asset's type", "default": "module" }, "location": { @@ -697,6 +697,20 @@ "additionalProperties": { "$ref": "#/definitions/OutputPort" } + }, + "metadata": { + "type": "object", + "description": "[TODO] Asset's metadata", + "additionalProperties": { + "type": "string" + } + }, + "parameters": { + "type": "array", + "description": "[TODO] Asset's parameters", + "items": { + "$ref": "#/definitions/ModuleAssetParameter" + } } } }, @@ -715,6 +729,44 @@ } } }, + "ModuleAssetParameter": { + "type": "object", + "description": "[TODO] Parameter for a custom module asset.", + "properties": { + "name": { + "type": "string", + "description": "Parameter name." + }, + "parameterType": { + "type": "string", + "description": "Parameter type." + }, + "modeValuesInfo": { + "type": "object", + "description": "[TODO] Add meaningful description here", + "additionalProperties": { + "$ref": "#/definitions/ModeValueInfo" + } + } + } + }, + "ModeValueInfo": { + "type": "object", + "description": "[TODO] Add meaningful description here.", + "properties": { + "interfaceString": { + "type": "string", + "description": "[TODO] Add meaningful description here." + }, + "parameters": { + "type": "array", + "description": "[TODO] Add meaningful description here.", + "items": { + "$ref": "#/definitions/ModuleAssetParameter" + } + } + } + }, "InputPort": { "type": "object", "description": "[TODO] Asset input port", From 3d49dfeec4a46ca4eb51de20326275fba6176540 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Thu, 21 Apr 2016 14:21:22 -0700 Subject: [PATCH 16/18] Renamed asset location property to 'locationInfo' --- .../2016-04-01-privatepreview/swagger/webservices.json | 2 +- arm-machinelearning/2016-05-01-preview/swagger/webservices.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json index b5c6f0e33334..1e886f57501e 100644 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json @@ -683,7 +683,7 @@ "description": "Asset's type", "default": "module" }, - "location": { + "locationInfo": { "$ref": "#/definitions/AssetLocation" }, "inputPorts": { diff --git a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json index 4ec7679e605e..7c62a8079239 100644 --- a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json +++ b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json @@ -683,7 +683,7 @@ "description": "Asset's type", "default": "module" }, - "location": { + "locationInfo": { "$ref": "#/definitions/AssetLocation" }, "inputPorts": { From b968aa36e426fa89726e8dfbad987b4201ea5218 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Tue, 26 Apr 2016 16:22:52 -0700 Subject: [PATCH 17/18] remove obsolete now spec updated documentation on multiple items in the spec made several items required as applicable --- .../swagger/webservices.json | 964 ------------------ .../swagger/webservices.json | 493 ++++----- 2 files changed, 222 insertions(+), 1235 deletions(-) delete mode 100644 arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json diff --git a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json b/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json deleted file mode 100644 index 1e886f57501e..000000000000 --- a/arm-machinelearning/2016-04-01-privatepreview/swagger/webservices.json +++ /dev/null @@ -1,964 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "AzureML Web Services Management Client", - "description": "[TODO] These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:
  • Create a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
  • Get All Available Operations
", - "version": "2016-04-01-privatepreview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json", - "text/json" - ], - "produces": [ - "application/json", - "text/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}": { - "put": { - "tags": [ - "WebServices" - ], - "operationId": "WebServices_CreateOrUpdateWebService", - "description": "Create a new Azure ML web service or update an existing one.", - "parameters": [ - { - "in": "body", - "name": "createOrUpdatePayload", - "description": "The payload to create or update the Azure ML web service.", - "required": true, - "schema": { - "$ref": "#/definitions/WebService" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebService" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/WebService" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "WebServices" - ], - "operationId": "WebServices_GetWebService", - "description": "Retrieve an Azure ML web service definition by its subscription, resource group and name.", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebService" - } - } - } - }, - "patch": { - "tags": [ - "WebServices" - ], - "operationId": "WebServices_PatchWebService", - "description": "Patch an existing Azure ML web service.", - "parameters": [ - { - "in": "body", - "name": "patchPayload", - "description": "The payload to patch the Azure ML with.", - "required": true, - "schema": { - "$ref": "#/definitions/WebService" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebService" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "WebServices" - ], - "operationId": "WebServices_RemoveWebService", - "description": "Remove an existing Azure ML web service.", - "responses": { - "202": { - "description": "Async delete operation was accepted." - }, - "204": { - "description": "No Content" - } - }, - "x-ms-long-running-operation": true - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "description": "Name of the resource group.", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "webServiceName", - "description": "The Azure ML web service name which you want to reach.", - "in": "path", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ] - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices/{webServiceName}/listKeys": { - "get": { - "tags": [ - "WebServices" - ], - "operationId": "WebServices_GetWebServiceKeys", - "description": "Get the primary and secondary access keys of a particular Azure ML web service", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "description": "Name of the resource group.", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "webServiceName", - "description": "The Azure ML web service name which you want to reach.", - "in": "path", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WebServiceKeys" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/webServices": { - "get": { - "tags": [ - "WebServices" - ], - "operationId": "WebServices_GetWebServicesInResourceGroup", - "description": "Retrieve all Azure ML web services in a given resource group.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "description": "Name of the resource group.", - "in": "path", - "type": "string", - "required": true - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "in": "query", - "name": "$skiptoken", - "type": "string", - "description": "Continuation token for pagination.", - "required": false - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PaginatedWebServicesList" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearning/webServices": { - "get": { - "tags": [ - "WebServices" - ], - "operationId": "WebServices_GetWebServicesInSubscription", - "description": "Retrieve all Azure ML web services in the current Azure subscription.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/APIVersionParameter" - }, - { - "in": "query", - "name": "$skiptoken", - "type": "string", - "description": "Continuation token for pagination.", - "required": false - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PaginatedWebServicesList" - } - } - } - } - }, - "/providers/Microsoft.MachineLearning/operations": { - "get": { - "operationId": "GetOperations", - "description": "Get all available operations for the Microsoft.MachineLearning provider.", - "parameters": [ - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "List of Operations", - "items": { - "$ref": "#/definitions/OperationSchema" - } - } - } - } - } - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "description": "Azure subscription id.", - "in": "path", - "type": "string", - "required": true - }, - "APIVersionParameter": { - "in": "query", - "name": "api-version", - "type": "string", - "description": "The versiong of the Microsoft.MachineLearning resource provider API to be used.", - "required": true - } - }, - "definitions": { - "WebService": { - "type": "object", - "title": "[TODO] Instance of an Azure ML web service resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/WebServiceProperties" - } - } - }, - "WebServiceProperties": { - "type": "object", - "description": "The set of properties specific to the Azure ML web service resource.", - "required": [ - "packageType" - ], - "discriminator": "packageType", - "properties": { - "title": { - "type": "string", - "description": "The title the Azure ML web service." - }, - "description": { - "type": "string", - "description": "The description the Azure ML web service." - }, - "createdOn": { - "type": "string", - "description": "The moment of time the Azure ML web service was created.", - "format": "date-time", - "readOnly": true - }, - "modifiedOn": { - "type": "string", - "description": "The moment of time the web service was last modified.", - "format": "date-time", - "readOnly": true - }, - "provisioningState": { - "type": "string", - "description": "The web service resource's provisioning state.", - "enum": [ - "Unknown", - "Provisioning", - "Succeeded", - "Failed", - "Canceled" - ], - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } - }, - "keys": { - "$ref": "#/definitions/WebServiceKeys" - }, - "readOnly": { - "type": "boolean", - "description": "True, if the web service should be read-only; False, otherwise" - }, - "swaggerLocation": { - "type": "string", - "description": "The uri for the swagger spec associated with this Azure ML web service.", - "readOnly": true - }, - "realtimeConfiguration": { - "description": "[TODO] Realtime configuration", - "$ref": "#/definitions/RealtimeConfiguration" - }, - "diagnostics": { - "description": "[TODO] Diagnostics settings", - "$ref": "#/definitions/DiagnosticsConfiguration" - }, - "storageAccount": { - "description": "[TODO] BYOS description", - "$ref": "#/definitions/StorageAccount" - }, - "machineLearningWorkspace": { - "description": "[TODO] Service workspace data", - "$ref": "#/definitions/MachineLearningWorkspace" - }, - "commitmentPlan": { - "description": "[TODO] Service commitment plan data", - "$ref": "#/definitions/CommitmentPlan" - }, - "input": { - "description": "[TODO] Service input definition", - "$ref": "#/definitions/ServiceInputOutputSpecification" - }, - "output": { - "description": "[TODO] Service output definition", - "$ref": "#/definitions/ServiceInputOutputSpecification" - }, - "assets": { - "description": "[TODO] Service assets", - "$ref": "#/definitions/AssetProperties" - }, - "parameters": { - "type": "object", - "description": "[TODO] Parameters of module package", - "additionalProperties": { - "type": "string" - } - }, - "packageType": { - "type": "string", - "description": "[TODO] Module package type", - "enum": [ - "Code", - "Graph" - ], - "readOnly": true, - "x-ms-enum": { - "name": "PackageType", - "modelAsString": false - } - } - } - }, - "WebServicePropertiesForGraph": { - "description": "[TODO] Payload for Graph package", - "x-ms-discriminator-value": "Graph", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" - } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Graph Package", - "properties": { - "nodes": { - "type": "object", - "description": "[TODO] Graph nodes collection", - "additionalProperties": { - "$ref": "#/definitions/GraphNode" - } - }, - "edges": { - "type": "array", - "description": "[TODO] List of Graph Edges", - "items": { - "$ref": "#/definitions/GraphEdge" - } - }, - "graphParameters": { - "type": "object", - "description": "[TODO] Graph parameter collection", - "additionalProperties": { - "$ref": "#/definitions/GraphParameter" - } - } - } - } - } - }, - "WebServicePropertiesForCode": { - "description": "[TODO] Payload for Code package", - "x-ms-discriminator-value": "Code", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" - } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Code Package", - "properties": { - "language": { - "type": "string", - "description": "[TODO] The language of source code", - "enum": [ - "Python-2.7", - "R-3.1" - ] - }, - "sourceCode": { - "type": "string", - "description": "[TODO] The source code" - }, - "zipFileAssetId": { - "type": "string", - "description": "[TODO] Zip file's Asset ID" - } - } - } - } - }, - "WebServiceKeys": { - "type": "object", - "description": "web service Keys", - "properties": { - "primary": { - "type": "string", - "description": "The Primary Key" - }, - "secondary": { - "type": "string", - "description": "The Secondary Key" - } - } - }, - "PaginatedWebServicesList": { - "type": "object", - "description": "[TODO] Paginated list of web services", - "properties": { - "value": { - "type": "array", - "description": "List of Web Services", - "items": { - "$ref": "#/definitions/WebService" - } - }, - "nextLink": { - "type": "string", - "description": "[TODO] Next Link" - } - } - }, - "RealtimeConfiguration": { - "type": "object", - "description": "Configuration settings for RRS", - "properties": { - "maxConcurrentCalls": { - "type": "integer", - "description": "[TODO] Max Concurrent Calls" - } - } - }, - "DiagnosticsConfiguration": { - "type": "object", - "description": "The Diagnostics Settings", - "properties": { - "level": { - "type": "string", - "description": "Trace Level: None, Error, All", - "enum": [ - "None", - "Error", - "All" - ], - "x-ms-enum": { - "name": "DiagnosticsLevel", - "modelAsString": false - } - }, - "expiry": { - "type": "string", - "description": "[TODO] Expiry date", - "format": "date-time" - } - } - }, - "StorageAccount": { - "type": "object", - "description": "[TODO] The Storage Account used in GraphSharp", - "properties": { - "name": { - "type": "string", - "description": "[TODO] The storage account's name" - }, - "key": { - "type": "string", - "description": "[TODO] The storage account's active key" - } - } - }, - "MachineLearningWorkspace": { - "type": "object", - "description": "[TODO] The machine learning workspace", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The Workspace ID" - } - } - }, - "CommitmentPlan": { - "type": "object", - "description": "[TODO] The commitment plan associated with this web service", - "properties": { - "id": { - "type": "string", - "description": "[TODO] The plan's ID" - } - } - }, - "ServiceInputOutputSpecification": { - "type": "object", - "description": "[TODO] The swagger schema describing the service's input.", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Interface title" - }, - "description": { - "type": "string", - "description": "[TODO] Description of the interface" - }, - "type": { - "type": "string", - "description": "[TODO] Interface properties' type. Always use 'object' here.", - "default": "object" - }, - "properties": { - "type": "object", - "description": "[TODO]", - "additionalProperties": { - "$ref": "#/definitions/TableSpecification" - } - } - } - }, - "TableSpecification": { - "type": "object", - "description": "[TODO] schema for a data table", - "properties": { - "title": { - "type": "string", - "description": "[TODO] Table title" - }, - "description": { - "type": "string", - "description": "[TODO] Table description" - }, - "type": { - "type": "string", - "description": "[TODO] Table properties' type. Always use 'object' here.", - "default": "object" - }, - "properties": { - "type": "object", - "description": "The set of columns within the data table", - "additionalProperties": { - "$ref": "#/definitions/ColumnSpecification" - } - } - } - }, - "ColumnSpecification": { - "type": "object", - "description": "[TODO] input column.", - "properties": { - "type": { - "type": "string", - "description": "[TODO] Data type" - }, - "format": { - "type": "string", - "description": "[TODO] Data format" - }, - "enum": { - "type": "array", - "description": "[TODO] Options", - "items": { - "type": "object" - } - }, - "x-ms-isnullable": { - "type": "boolean", - "description": "[TODO] Is nullable" - }, - "x-ms-isordered": { - "type": "boolean", - "description": "[TODO] Is enum in order" - } - } - }, - "AssetProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetItem" - } - }, - "AssetItem": { - "type": "object", - "description": "[TODO] Service asset details", - "properties": { - "name": { - "type": "string", - "description": "Asset's friendly name" - }, - "type": { - "type": "string", - "description": "Asset's type", - "default": "module" - }, - "locationInfo": { - "$ref": "#/definitions/AssetLocation" - }, - "inputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/InputPort" - } - }, - "outputPorts": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/OutputPort" - } - }, - "metadata": { - "type": "object", - "description": "[TODO] Asset's metadata", - "additionalProperties": { - "type": "string" - } - }, - "parameters": { - "type": "array", - "description": "[TODO] Asset's parameters", - "items": { - "$ref": "#/definitions/ModuleAssetParameter" - } - } - } - }, - "AssetLocation": { - "type": "object", - "description": "[TODO] Asset Location", - "properties": { - "uri": { - "type": "string", - "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", - "format": "url" - }, - "credentials": { - "type": "string", - "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." - } - } - }, - "ModuleAssetParameter": { - "type": "object", - "description": "[TODO] Parameter for a custom module asset.", - "properties": { - "name": { - "type": "string", - "description": "Parameter name." - }, - "parameterType": { - "type": "string", - "description": "Parameter type." - }, - "modeValuesInfo": { - "type": "object", - "description": "[TODO] Add meaningful description here", - "additionalProperties": { - "$ref": "#/definitions/ModeValueInfo" - } - } - } - }, - "ModeValueInfo": { - "type": "object", - "description": "[TODO] Add meaningful description here.", - "properties": { - "interfaceString": { - "type": "string", - "description": "[TODO] Add meaningful description here." - }, - "parameters": { - "type": "array", - "description": "[TODO] Add meaningful description here.", - "items": { - "$ref": "#/definitions/ModuleAssetParameter" - } - } - } - }, - "InputPort": { - "type": "object", - "description": "[TODO] Asset input port", - "properties": { - "type": { - "type": "string", - "description": "[TODO] dataset or zip" - } - } - }, - "OutputPort": { - "type": "object", - "description": "[TODO] Asset output port", - "properties": { - "type": { - "type": "string", - "description": "[TODO] dataset or zip" - } - } - }, - "GraphNode": { - "type": "object", - "description": "[TODO] Graph Node", - "properties": { - "assetId": { - "type": "string", - "description": "[TODO] Asset ID" - }, - "inputId": { - "type": "string", - "description": "[TODO] Input ID" - }, - "outputId": { - "type": "string", - "description": "[TODO] Output ID" - }, - "parameters": { - "type": "object", - "description": "[TODO] Node Parameters", - "additionalProperties": { - "type": "string" - } - } - } - }, - "GraphEdge": { - "type": "object", - "description": "[TODO] Graph edge", - "properties": { - "sourceNodeId": { - "type": "string", - "description": "[TODO] Edge source" - }, - "sourcePortId": { - "type": "string", - "description": "[TODO] Source node output port id" - }, - "targetNodeId": { - "type": "string", - "description": "[TODO] Edge target" - }, - "targetPortId": { - "type": "string", - "description": "[TODO] Target node input port id" - } - } - }, - "GraphParameter": { - "type": "object", - "description": "[TODO] Graph Parameters", - "properties": { - "description": { - "type": "string", - "description": "Description for this graph parameter." - }, - "type": { - "type": "string", - "description": "Graph parameter's type.", - "enum": [ - "String", - "Int", - "Float", - "Enumerated", - "Script", - "Mode", - "Credential", - "Boolean", - "Double", - "ColumnPicker", - "ParameterRange", - "DataGatewayName" - ], - "x-ms-enum": { - "name": "ParameterType", - "modelAsString": false - } - }, - "links": { - "type": "array", - "description": "[TODO] Links of this parameter", - "items": { - "$ref": "#/definitions/GraphParameterLink" - } - } - } - }, - "GraphParameterLink": { - "type": "object", - "description": "[TODO] The link in graph parameter", - "properties": { - "nodeId": { - "type": "string", - "description": "[TODO] The node ID" - }, - "parameterKey": { - "type": "string", - "description": "[TODO] The parameter key" - } - } - }, - "Resource": { - "required": [ - "location" - ], - "properties": { - "id": { - "description": "Resource Id", - "type": "string" - }, - "name": { - "description": "Resource Name", - "type": "string" - }, - "location": { - "description": "Resource Location", - "type": "string" - }, - "type": { - "description": "Resource type", - "type": "string" - }, - "tags": { - "description": "Resource tags", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "OperationSchema": { - "type": "object", - "description": "[TODO] The web service Operation Description", - "properties": { - "name": { - "type": "string", - "description": "The operation name" - }, - "display": { - "type": "object", - "description": "[TODO] Display", - "properties": { - "provider": { - "type": "string", - "description": "[TODO] Provider", - "default": "Machine Learning" - }, - "resource": { - "type": "string", - "description": "[TODO] Resource", - "default": "web service" - }, - "operation": { - "type": "string", - "description": "[TODO] Operation" - }, - "description": { - "type": "string", - "description": "[TODO] Description" - } - } - }, - "origin": { - "type": "string", - "description": "[TODO] Origin", - "enum": [ - "user", - "system", - "user, system" - ] - } - } - } - } -} \ No newline at end of file diff --git a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json index 7c62a8079239..44025bcffb7f 100644 --- a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json +++ b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "AzureML Web Services Management Client", - "description": "[TODO] These APIs allows end users to operate on Web Services in Azure ML. They support the following operations:
  • Create a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
  • Get All Available Operations
", + "title": "Azure ML Web Services Management Client", + "description": "These APIs allow end users to operate on Azure Machine Learning Web Services resources. They support the following operations:
  • Create a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
", "version": "2016-05-01-preview" }, "host": "management.azure.com", @@ -72,12 +72,12 @@ "WebServices" ], "operationId": "WebServices_PatchWebService", - "description": "Patch an existing Azure ML web service.", + "description": "Patch an existing Azure ML web service resource.", "parameters": [ { "in": "body", "name": "patchPayload", - "description": "The payload to patch the Azure ML with.", + "description": "The payload to patch the Azure ML web service with.", "required": true, "schema": { "$ref": "#/definitions/WebService" @@ -139,7 +139,7 @@ "WebServices" ], "operationId": "WebServices_GetWebServiceKeys", - "description": "Get the primary and secondary access keys of a particular Azure ML web service", + "description": "Get the access keys of a particular Azure ML web service", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -242,35 +242,7 @@ } } } - }, - "/providers/Microsoft.MachineLearning/operations": { - "get": { - "operationId": "GetOperations", - "description": "Get all available operations for the Microsoft.MachineLearning provider.", - "parameters": [ - { - "$ref": "#/parameters/APIVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "List of Operations", - "items": { - "$ref": "#/definitions/OperationSchema" - } - } - } - } - } - } - } - } + } }, "parameters": { "SubscriptionIdParameter": { @@ -289,9 +261,41 @@ } }, "definitions": { + "Resource": { + "required": [ + "location" + ], + "properties": { + "id": { + "description": "Resource Id", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource Name", + "type": "string" + }, + "location": { + "description": "Resource Location", + "type": "string" + }, + "type": { + "description": "Resource type", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, "WebService": { "type": "object", - "title": "[TODO] Instance of an Azure ML web service resource.", + "description": "Instance of an Azure ML web service resource.", "allOf": [ { "$ref": "#/definitions/Resource" @@ -299,7 +303,8 @@ ], "properties": { "properties": { - "$ref": "#/definitions/WebServiceProperties" + "$ref": "#/definitions/WebServiceProperties", + "description": "Web service resource properties." } } }, @@ -313,11 +318,11 @@ "properties": { "title": { "type": "string", - "description": "The title the Azure ML web service." + "description": "The title of the Azure ML web service." }, "description": { "type": "string", - "description": "The description the Azure ML web service." + "description": "The description of the Azure ML web service." }, "createdOn": { "type": "string", @@ -341,80 +346,75 @@ "Failed", "Canceled" ], - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": false - } + "readOnly": true }, "keys": { - "$ref": "#/definitions/WebServiceKeys" + "$ref": "#/definitions/WebServiceKeys", + "description": "The set of access keys for the web service. If not specified at creation time (PUT), they will be generated automatically by the resource provider." }, "readOnly": { "type": "boolean", - "description": "True, if the web service should be read-only; False, otherwise" + "description": "If true, the web service can no longer be updated / patched, only removed. Otherwise, the service resource supports changes." }, "swaggerLocation": { "type": "string", - "description": "The uri for the swagger spec associated with this Azure ML web service.", + "description": "The uri for the swagger spec associated with this web service.", "readOnly": true }, "realtimeConfiguration": { - "description": "[TODO] Realtime configuration", - "$ref": "#/definitions/RealtimeConfiguration" + "$ref": "#/definitions/RealtimeConfiguration", + "description": "Configuration for the service's realtime endpoint." }, "diagnostics": { - "description": "[TODO] Diagnostics settings", - "$ref": "#/definitions/DiagnosticsConfiguration" + "$ref": "#/definitions/DiagnosticsConfiguration", + "description": "Settings controlling the diagnostics traces collection for the web service." }, "storageAccount": { - "description": "[TODO] BYOS description", - "$ref": "#/definitions/StorageAccount" + "$ref": "#/definitions/StorageAccount", + "description": "The storage account associated with the service. This is used to store both datasets and diagnostic traces. This information is required at creation time (PUT) and only the key is updateable after that. The account credentials are hidden on a GET web service call." }, "machineLearningWorkspace": { - "description": "[TODO] Service workspace data", - "$ref": "#/definitions/MachineLearningWorkspace" + "$ref": "#/definitions/MachineLearningWorkspace", + "description": "This is only populated at creation time (PUT) for web services originating from an AzureML Studio experiment." }, "commitmentPlan": { - "description": "[TODO] Service commitment plan data", - "$ref": "#/definitions/CommitmentPlan" + "$ref": "#/definitions/CommitmentPlan", + "description": "The commitment plan associated with this web service. This is required to be specified at creation time (PUT) and is not updateable afterwards." }, "input": { - "description": "[TODO] Service input definition", - "$ref": "#/definitions/ServiceInputOutputSpecification" + "$ref": "#/definitions/ServiceInputOutputSpecification", + "description": "Swagger schema for the service's input(s), as applicable." }, "output": { - "description": "[TODO] Service output definition", - "$ref": "#/definitions/ServiceInputOutputSpecification" + "$ref": "#/definitions/ServiceInputOutputSpecification", + "description": "Swagger schema for the service's output(s), as applicable." }, "assets": { - "description": "[TODO] Service assets", - "$ref": "#/definitions/AssetProperties" + "type": "object", + "description": "Set of assets associated with the web service.", + "additionalProperties": { + "$ref": "#/definitions/AssetItem" + } }, "parameters": { "type": "object", - "description": "[TODO] Parameters of module package", + "description": "The set of global parameters values defined for the web service, given as a global parameter name -> default value collection. If no default value is specified, the parameter is considered to be required.", "additionalProperties": { "type": "string" } }, "packageType": { "type": "string", - "description": "[TODO] Module package type", - "enum": [ - "Code", + "description": "The type of package deployed with this web service. Only Graph based services are supported at this time.", + "enum": [ "Graph" ], - "readOnly": true, - "x-ms-enum": { - "name": "PackageType", - "modelAsString": false - } + "readOnly": true } } }, "WebServicePropertiesForGraph": { - "description": "[TODO] Payload for Graph package", + "description": "Properties specific to a Graph based web service.", "x-ms-discriminator-value": "Graph", "allOf": [ { @@ -424,25 +424,25 @@ "properties": { "package": { "type": "object", - "description": "[TODO] Graph Package", + "description": "The definition of the graph package making up this web service.", "properties": { "nodes": { "type": "object", - "description": "[TODO] Graph nodes collection", + "description": "The set of nodes making up the graph, provided as a nodeId -> GraphNode map", "additionalProperties": { "$ref": "#/definitions/GraphNode" } }, "edges": { "type": "array", - "description": "[TODO] List of Graph Edges", + "description": "The list of edges making up the graph.", "items": { "$ref": "#/definitions/GraphEdge" } }, "graphParameters": { "type": "object", - "description": "[TODO] Graph parameter collection", + "description": "The collection of global parameters for the graph, given as a global parameter name -> GraphParameter map. Each parameter here has a 1:1 match with the global parameters values map declared at the WebServiceProperties level.", "additionalProperties": { "$ref": "#/definitions/GraphParameter" } @@ -451,287 +451,299 @@ } } }, - "WebServicePropertiesForCode": { - "description": "[TODO] Payload for Code package", - "x-ms-discriminator-value": "Code", - "allOf": [ - { - "$ref": "#/definitions/WebServiceProperties" - } - ], - "properties": { - "package": { - "type": "object", - "description": "[TODO] Code Package", - "properties": { - "language": { - "type": "string", - "description": "[TODO] The language of source code", - "enum": [ - "Python-2.7", - "R-3.1" - ] - }, - "sourceCode": { - "type": "string", - "description": "[TODO] The source code" - }, - "zipFileAssetId": { - "type": "string", - "description": "[TODO] Zip file's Asset ID" - } - } - } - } - }, "WebServiceKeys": { "type": "object", - "description": "web service Keys", + "description": "Access keys for the web service calls.", "properties": { "primary": { "type": "string", - "description": "The Primary Key" + "description": "The primary access key." }, "secondary": { "type": "string", - "description": "The Secondary Key" + "description": "The secondary access key." } } }, "PaginatedWebServicesList": { "type": "object", - "description": "[TODO] Paginated list of web services", + "description": "Paginated list of web services.", "properties": { "value": { "type": "array", - "description": "List of Web Services", + "description": "List of web services objects.", "items": { "$ref": "#/definitions/WebService" } }, "nextLink": { "type": "string", - "description": "[TODO] Next Link" + "description": "Continuation link to be used to potentially retrieve the next page of results in the list." } } }, "RealtimeConfiguration": { "type": "object", - "description": "Configuration settings for RRS", + "description": "Holds the available configuration options for an Azure ML web service endpoint.", "properties": { "maxConcurrentCalls": { "type": "integer", - "description": "[TODO] Max Concurrent Calls" + "minimum": 4, + "maximum": 200, + "description": "Maximum number of concurrent calls allowed on the realtime endpoint." } } }, "DiagnosticsConfiguration": { "type": "object", - "description": "The Diagnostics Settings", + "description": "Diagnostics settings for an Azure ML web service.", "properties": { "level": { "type": "string", - "description": "Trace Level: None, Error, All", + "description": "Level of tracing to be used: None - disables tracing; Error - collects only error (stderr) traces; All - collects all traces (stdout and stderr).", "enum": [ "None", "Error", "All" - ], - "x-ms-enum": { - "name": "DiagnosticsLevel", - "modelAsString": false - } + ] }, "expiry": { "type": "string", - "description": "[TODO] Expiry date", + "description": "Moment of time after which diagnostics are no longer collected. If null, diagnostic collection is not time limited.", "format": "date-time" } } }, "StorageAccount": { "type": "object", - "description": "[TODO] The Storage Account used in GraphSharp", + "description": "Access information for a storage account.", "properties": { "name": { "type": "string", - "description": "[TODO] The storage account's name" + "description": "The storage account's name." }, "key": { "type": "string", - "description": "[TODO] The storage account's active key" + "description": "The storage account's active key." } } }, "MachineLearningWorkspace": { "type": "object", - "description": "[TODO] The machine learning workspace", + "description": "Information about the machine learning workspace containing the experiment that is source for the web service.", "properties": { "id": { "type": "string", - "description": "[TODO] The Workspace ID" + "description": "The workspace ARM resource id." } - } + }, + "required": [ + "id" + ] }, "CommitmentPlan": { "type": "object", - "description": "[TODO] The commitment plan associated with this web service", + "description": "Information about the machine learning commitment plan associated with the web service.", "properties": { "id": { "type": "string", - "description": "[TODO] The plan's ID" + "description": "The commitment plan ARM resource id." } - } + }, + "required": [ + "id" + ] }, "ServiceInputOutputSpecification": { "type": "object", - "description": "[TODO] The swagger schema describing the service's input.", + "description": "The swagger 2.0 schema describing the service's inputs or outputs. See Swagger specification: http://swagger.io/specification/", "properties": { "title": { "type": "string", - "description": "[TODO] Interface title" + "description": "Swagger schema title." }, "description": { "type": "string", - "description": "[TODO] Description of the interface" + "description": "Swagger schema description." }, "type": { "type": "string", - "description": "[TODO] Interface properties' type. Always use 'object' here.", + "description": "The type of the entity described in swagger. Always 'object'.", "default": "object" }, "properties": { "type": "object", - "description": "[TODO]", + "description": "Collection of (name -> swagger schema) for each input or output of the web service.", "additionalProperties": { "$ref": "#/definitions/TableSpecification" } } - } + }, + "required": [ + "type", + "properties" + ] }, "TableSpecification": { "type": "object", - "description": "[TODO] schema for a data table", + "description": "The swagger 2.0 schema describing a single service input or output. See Swagger specification: http://swagger.io/specification/", "properties": { "title": { "type": "string", - "description": "[TODO] Table title" + "description": "Swagger schema title." }, "description": { "type": "string", - "description": "[TODO] Table description" + "description": "Swagger schema description." }, "type": { "type": "string", - "description": "[TODO] Table properties' type. Always use 'object' here.", + "description": "The type of the entity described in swagger. Always 'object'.", "default": "object" }, "properties": { "type": "object", - "description": "The set of columns within the data table", + "description": "The set of columns within the data table.", "additionalProperties": { "$ref": "#/definitions/ColumnSpecification" } } - } + }, + "required": [ + "type", + "properties" + ] }, "ColumnSpecification": { "type": "object", - "description": "[TODO] input column.", + "description": "Swagger 2.0 schema for a column within the data table representing a web service input or output. See Swagger specification: http://swagger.io/specification/", "properties": { "type": { "type": "string", - "description": "[TODO] Data type" + "description": "Data type of the column.", + "enum": [ + "Boolean", + "Integer", + "Number", + "String" + ] }, "format": { "type": "string", - "description": "[TODO] Data format" + "description": "Additional format information for the data type.", + "enum": [ + "Byte", + "Char", + "Datetime", + "Double", + "Duration", + "Float", + "Int8", + "Int16", + "Int32", + "Int64", + "Uint8", + "Uint16", + "Uint32", + "Uint64" + ] }, "enum": { "type": "array", - "description": "[TODO] Options", + "description": "If the data type is categorical, this provides the list of accepted categories.", "items": { "type": "object" } }, "x-ms-isnullable": { "type": "boolean", - "description": "[TODO] Is nullable" + "description": "Flag indicating if the type supports null values or not." }, "x-ms-isordered": { "type": "boolean", - "description": "[TODO] Is enum in order" + "description": "Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column." } - } - }, - "AssetProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/AssetItem" - } + }, + "required": [ + "type" + ] }, "AssetItem": { "type": "object", - "description": "[TODO] Service asset details", + "description": "Information about an asset associated with the web service.", "properties": { "name": { "type": "string", - "description": "Asset's friendly name" + "description": "Asset's friendly name." }, "type": { "type": "string", - "description": "Asset's type", - "default": "module" + "description": "Asset's type.", + "enum": [ + "Module", + "Resource" + ] }, "locationInfo": { + "description": "Access information for the asset.", "$ref": "#/definitions/AssetLocation" }, "inputPorts": { "type": "object", + "description": "Information about the asset's input ports.", "additionalProperties": { "$ref": "#/definitions/InputPort" } }, "outputPorts": { "type": "object", + "description": "Information about the asset's output ports.", "additionalProperties": { "$ref": "#/definitions/OutputPort" } }, "metadata": { "type": "object", - "description": "[TODO] Asset's metadata", + "description": "If the asset is a custom module, this holds the module's metadata.", "additionalProperties": { "type": "string" } }, "parameters": { "type": "array", - "description": "[TODO] Asset's parameters", + "description": "If the asset is a custom module, this holds the module's parameters.", "items": { "$ref": "#/definitions/ModuleAssetParameter" } } - } + }, + "required": [ + "name", + "type", + "locationInfo" + ] }, "AssetLocation": { "type": "object", - "description": "[TODO] Asset Location", + "description": "Describes the access location for a web service asset.", "properties": { "uri": { "type": "string", - "description": "[TODO] Location URI, https:// OR aml:// OR idv :// OR hdfs://", + "description": "The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user asets", "format": "url" }, "credentials": { "type": "string", - "description": "[TODO] null if in BYOS / SAS token / connection string / user asset partition key (when in graphSharp)/ etc." + "description": "Access credentials for the asset, if applicable (e.g. asset specified by storage account connection string + blob URI)" } - } + }, + "required": [ + "uri" + ] }, "ModuleAssetParameter": { "type": "object", - "description": "[TODO] Parameter for a custom module asset.", + "description": "Parameter for a custom module asset.", "properties": { "name": { "type": "string", @@ -769,43 +781,51 @@ }, "InputPort": { "type": "object", - "description": "[TODO] Asset input port", + "description": "Asset input port", "properties": { "type": { "type": "string", - "description": "[TODO] dataset or zip" + "description": "Port data type.", + "enum": [ + "Dataset" + ], + "default": "Dataset" } } }, "OutputPort": { "type": "object", - "description": "[TODO] Asset output port", + "description": "Asset output port", "properties": { "type": { "type": "string", - "description": "[TODO] dataset or zip" + "description": "Port data type.", + "enum": [ + "Dataset" + ], + "default": "Dataset" } } }, "GraphNode": { "type": "object", - "description": "[TODO] Graph Node", + "description": "Specifies a node in the web service graph. The node can either be an input, output or asset node, so only one of the corresponding id properties is populated at any given time.", "properties": { "assetId": { "type": "string", - "description": "[TODO] Asset ID" + "description": "The id of the asset represented by this node." }, "inputId": { "type": "string", - "description": "[TODO] Input ID" + "description": "The id of the input element represented by this node." }, "outputId": { "type": "string", - "description": "[TODO] Output ID" + "description": "The id of the output element represented by this node." }, "parameters": { "type": "object", - "description": "[TODO] Node Parameters", + "description": "If applicable, parameters of the node. Global graph parameters map into these, with values set at runtime.", "additionalProperties": { "type": "string" } @@ -814,33 +834,33 @@ }, "GraphEdge": { "type": "object", - "description": "[TODO] Graph edge", + "description": "Defines an edge within the web service's graph.", "properties": { "sourceNodeId": { "type": "string", - "description": "[TODO] Edge source" + "description": "The source graph node's identifier." }, "sourcePortId": { "type": "string", - "description": "[TODO] Source node output port id" + "description": "The identifier of the source node's port that the edge connects from." }, "targetNodeId": { "type": "string", - "description": "[TODO] Edge target" + "description": "The destination graph node's identifier." }, "targetPortId": { "type": "string", - "description": "[TODO] Target node input port id" + "description": "The identifier of the destination node's port that the edge connects into." } } }, "GraphParameter": { "type": "object", - "description": "[TODO] Graph Parameters", + "description": "Defines a global parameter in the graph.", "properties": { "description": { "type": "string", - "description": "Description for this graph parameter." + "description": "Description of this graph parameter." }, "type": { "type": "string", @@ -858,107 +878,38 @@ "ColumnPicker", "ParameterRange", "DataGatewayName" - ], - "x-ms-enum": { - "name": "ParameterType", - "modelAsString": false - } + ] }, "links": { "type": "array", - "description": "[TODO] Links of this parameter", + "description": "Association links for this parameter to nodes in the graph.", "items": { "$ref": "#/definitions/GraphParameterLink" } } - } + }, + "required": [ + "type", + "links" + ] }, "GraphParameterLink": { "type": "object", - "description": "[TODO] The link in graph parameter", + "description": "Association link for a graph global parameter to a node in the graph.", "properties": { "nodeId": { "type": "string", - "description": "[TODO] The node ID" + "description": "The graph node's identifier" }, "parameterKey": { "type": "string", - "description": "[TODO] The parameter key" + "description": "The identifier of the node parameter that the global parameter maps to." } - } - }, - "Resource": { + }, "required": [ - "location" - ], - "properties": { - "id": { - "description": "Resource Id", - "type": "string" - }, - "name": { - "description": "Resource Name", - "type": "string" - }, - "location": { - "description": "Resource Location", - "type": "string" - }, - "type": { - "description": "Resource type", - "type": "string" - }, - "tags": { - "description": "Resource tags", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "OperationSchema": { - "type": "object", - "description": "[TODO] The web service Operation Description", - "properties": { - "name": { - "type": "string", - "description": "The operation name" - }, - "display": { - "type": "object", - "description": "[TODO] Display", - "properties": { - "provider": { - "type": "string", - "description": "[TODO] Provider", - "default": "Machine Learning" - }, - "resource": { - "type": "string", - "description": "[TODO] Resource", - "default": "web service" - }, - "operation": { - "type": "string", - "description": "[TODO] Operation" - }, - "description": { - "type": "string", - "description": "[TODO] Description" - } - } - }, - "origin": { - "type": "string", - "description": "[TODO] Origin", - "enum": [ - "user", - "system", - "user, system" - ] - } - } + "nodeId", + "parameterKey" + ] } } -} \ No newline at end of file +} From 2924baac76f91a899d10875f7313f0923f281b51 Mon Sep 17 00:00:00 2001 From: Tudor Didilescu Date: Wed, 27 Apr 2016 15:53:51 -0700 Subject: [PATCH 18/18] added missing documentation for module asset parameters --- .../2016-05-01-preview/swagger/webservices.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json index 44025bcffb7f..f749439e44b0 100644 --- a/arm-machinelearning/2016-05-01-preview/swagger/webservices.json +++ b/arm-machinelearning/2016-05-01-preview/swagger/webservices.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Azure ML Web Services Management Client", - "description": "These APIs allow end users to operate on Azure Machine Learning Web Services resources. They support the following operations:
  • Create a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
", + "description": "These APIs allow end users to operate on Azure Machine Learning Web Services resources. They support the following operations:
  • Create or update a web service
  • Get a web service
  • Patch a web service
  • Delete a web service
  • Get All Web Services in a Resource Group
  • Get All Web Services in a Subscription
  • Get Web Services Keys
", "version": "2016-05-01-preview" }, "host": "management.azure.com", @@ -743,7 +743,7 @@ }, "ModuleAssetParameter": { "type": "object", - "description": "Parameter for a custom module asset.", + "description": "Parameter definition for a module asset.", "properties": { "name": { "type": "string", @@ -755,7 +755,7 @@ }, "modeValuesInfo": { "type": "object", - "description": "[TODO] Add meaningful description here", + "description": "Definitions for nested interface parameters if this is a complex module parameter.", "additionalProperties": { "$ref": "#/definitions/ModeValueInfo" } @@ -764,15 +764,15 @@ }, "ModeValueInfo": { "type": "object", - "description": "[TODO] Add meaningful description here.", + "description": "Nested parameter definition.", "properties": { "interfaceString": { "type": "string", - "description": "[TODO] Add meaningful description here." + "description": "The interface string name for the nested parameter." }, "parameters": { "type": "array", - "description": "[TODO] Add meaningful description here.", + "description": "The definition of the parameter.", "items": { "$ref": "#/definitions/ModuleAssetParameter" }