diff --git a/README.md b/README.md index 3be883931b37..0efc3c778444 100644 --- a/README.md +++ b/README.md @@ -44,11 +44,21 @@ The structure should appear like so: │   └── swagger │   └── service.json ├── arm-web +├── documentation └── readme.md ``` At this point, the specifications are expected to be in swagger format. +## Creating the Swagger Specification for Azure +This [document](./documentation/creating-swagger.md) will help you understand how AutoRest converts Swagger in to code. + +## How to validate your swagger +* [You can use this json schema validator](https://json-schema-validator.herokuapp.com/) + * In the upper left box, paste the [swagger schema from here](https://github.com/swagger-api/swagger-spec/blob/master/schemas/v2.0/schema.json) + * In the lower left box, paste your swagger json + * Upon clicking the validate button, you should either see errors or success. + ## Generating Code from Specifications If you are interested in generating code from these specifications, please check out [AutoRest](https://github.com/azure/autorest). There you will find the code generator as well as instructions on how to use it. diff --git a/arm-authorization/2015-07-01/swagger/authorization.json b/arm-authorization/2015-07-01/swagger/authorization.json index 33cc49779d94..beb0dcd31c59 100644 --- a/arm-authorization/2015-07-01/swagger/authorization.json +++ b/arm-authorization/2015-07-01/swagger/authorization.json @@ -44,7 +44,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -79,7 +79,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -144,7 +144,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -224,7 +224,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -753,11 +753,11 @@ "description": "Role definition id." }, { - "name": "parameters", + "name": "roleDefinition", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/RoleDefinitionCreateOrUpdateParameters" + "$ref": "#/definitions/RoleDefinition" }, "description": "Role definition." }, @@ -850,9 +850,9 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/RoleDefinition" + "x-ms-odata": "#/definitions/RoleDefinitionFilter" } } }, @@ -866,6 +866,15 @@ }, "description": "Role Assignments filter" }, + "RoleDefinitionFilter": { + "properties": { + "roleName": { + "type": "string", + "description": "Returns role definition with the specific name." + } + }, + "description": "Role Definitions filter" + }, "ClassicAdministratorProperties": { "properties": { "emailAddress": { @@ -1163,15 +1172,6 @@ }, "description": "Role definition." }, - "RoleDefinitionCreateOrUpdateParameters": { - "properties": { - "RoleDefinition": { - "$ref": "#/definitions/RoleDefinition", - "description": "Gets or sets role definition properties." - } - }, - "description": "Role definition create or update parameters." - }, "RoleDefinitionListResult": { "properties": { "value": { diff --git a/arm-cdn/2015-06-01/swagger/cdn.json b/arm-cdn/2015-06-01/swagger/cdn.json new file mode 100644 index 000000000000..4378befe0ecc --- /dev/null +++ b/arm-cdn/2015-06-01/swagger/cdn.json @@ -0,0 +1,2330 @@ +{ + "swagger": "2.0", + "info": { + "version": "2015-06-01", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure. For more information, see Authenticating Azure Resource Manager requests." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "summary": "Lists the CDN Profiles within a resource group", + "operationId": "Profiles_ListByResourceGroup", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "summary": "Gets a CDN profile with the specified parameters", + "operationId": "Profiles_Get", + "parameters": [ + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "summary": "Creates a new CDN Profile with the specified parameters", + "operationId": "Profiles_Create", + "parameters": [ + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "profileProperties", + "in": "body", + "description": "Profile properties needed for creation", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileCreateParameters" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Profiles" + ], + "summary": "Updates an existing CDN Profile with the specified parameters", + "operationId": "Profiles_Update", + "parameters": [ + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "profileProperties", + "in": "body", + "description": "Profile properties needed for update", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpdateParameters" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Profiles" + ], + "summary": "Deletes an existing CDN Profile with the specified parameters. Deleting a profile will result in the deletion of all sub resources including endpoints, origins and CustomDomains", + "operationId": "Profiles_DeleteIfExists", + "parameters": [ + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri": { + "post": { + "tags": [ + "Profiles" + ], + "summary": "Generates a dynamic SSO URI used to sign in to the CDN Supplemental Portal used for advanced management tasks, such as Country Filtering, Advanced HTTP Reports, and Real-time Stats and Alerts. The SSO URI changes approximately every 10 minutes.", + "operationId": "Profiles_GenerateSsoUri", + "parameters": [ + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SsoUri" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "summary": "Lists existing CDN endpoints within a profile", + "operationId": "Endpoints_ListByProfile", + "parameters": [ + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EndpointListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "summary": "Gets an existing CDN endpoint with the specified parameters", + "operationId": "Endpoints_Get", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "summary": "Creates a new CDN endpoint with the specified parameters", + "operationId": "Endpoints_Create", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "endpointProperties", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointCreateParameters" + } + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Endpoints" + ], + "summary": "Updates an existing CDN endpoint with the specified parameters. Only tags and OriginHostHeader can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update custom domains, use the Update Custom Domain operation.", + "operationId": "Endpoints_Update", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "endpointProperties", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdateParameters" + } + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Endpoints" + ], + "summary": "deletes an existing CDN endpoint with the specified parameters", + "operationId": "Endpoints_DeleteIfExists", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start": { + "post": { + "tags": [ + "Endpoints" + ], + "summary": "Starts an existing stopped CDN endpoint", + "operationId": "Endpoints_Start", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously" + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop": { + "post": { + "tags": [ + "Endpoints" + ], + "summary": "Stops an existing running CDN endpoint", + "operationId": "Endpoints_Stop", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously" + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge": { + "post": { + "tags": [ + "Endpoints" + ], + "summary": "Forcibly purges CDN endpoint content", + "operationId": "Endpoints_PurgeContent", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be purged. Path can describe a file or directory.", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeParameters" + } + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously" + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load": { + "post": { + "tags": [ + "Endpoints" + ], + "summary": "Forcibly pre-loads CDN endpoint content", + "operationId": "Endpoints_LoadContent", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be loaded. Path should describe a file.", + "required": true, + "schema": { + "$ref": "#/definitions/LoadParameters" + } + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously" + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "Endpoints" + ], + "summary": "Validates a Custom Domain mapping to ensure it maps to the correct CNAME in DNS", + "operationId": "Endpoints_ValidateCustomDomain", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to validate", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCustomDomainInput" + } + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins": { + "get": { + "tags": [ + "Origins" + ], + "summary": "Lists the existing CDN Origins within an Endpoint", + "operationId": "Origins_ListByEndpoint", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OriginListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}": { + "get": { + "tags": [ + "Origins" + ], + "summary": "Gets an existing CDN Origin within an Endpoint", + "operationId": "Origins_Get", + "parameters": [ + { + "name": "originName", + "in": "path", + "description": "Name of the origin, an arbitrary value but it needs to be unique under endpoint", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Origins" + ], + "summary": "Creates a new CDN Origin within an Endpoint", + "operationId": "Origins_Create", + "parameters": [ + { + "name": "originName", + "in": "path", + "description": "Name of the origin, an arbitrary value but it needs to be unique under endpoint", + "required": true, + "type": "string" + }, + { + "name": "originProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginParameters" + } + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Origins" + ], + "summary": "Updates an existing CDN Origin within an Endpoint", + "operationId": "Origins_Update", + "parameters": [ + { + "name": "originName", + "in": "path", + "description": "Name of the origin, an arbitrary value but it needs to be unique under endpoint", + "required": true, + "type": "string" + }, + { + "name": "originProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginParameters" + } + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Origins" + ], + "summary": "Deletes an existing CDN Origin within an Endpoint", + "operationId": "Origins_DeleteIfExists", + "parameters": [ + { + "name": "originName", + "in": "path", + "description": "Name of the origin, an arbitrary value but it needs to be unique under endpoint", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains": { + "get": { + "tags": [ + "CustomDomains" + ], + "summary": "Lists the existing CDN Custom Domains within an Endpoint", + "operationId": "CustomDomains_ListByEndpoint", + "parameters": [ + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomDomainListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "CustomDomains" + ], + "summary": "Gets an existing CDN Custom Domain within an Endpoint", + "operationId": "CustomDomains_Get", + "parameters": [ + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CustomDomains" + ], + "summary": "Creates a new CDN Custom Domain within an Endpoint", + "operationId": "CustomDomains_Create", + "parameters": [ + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain properties required for creation", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainParameters" + } + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "CustomDomains" + ], + "summary": "Updates an existing CDN Custom Domain within an Endpoint", + "operationId": "CustomDomains_Update", + "parameters": [ + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain properties to update", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainParameters" + } + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "CustomDomains" + ], + "summary": "Deletes an existing CDN Custom Domain within an Endpoint", + "operationId": "CustomDomains_DeleteIfExists", + "parameters": [ + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint within the CDN profile", + "required": true, + "type": "string" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile within the resource group", + "required": true, + "type": "string" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group within the Azure subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "summary": "Check the availability of a resource name. This is needed for resources where name is globally unique (ex: endpoint). With this operation checks if the name is available or not without creating the resource.", + "operationId": "NameAvailability_CheckNameAvailability", + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "input to check", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Cdn/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available CDN REST API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "Profile": { + "description": "CDN profile represents the top level resource and the entry point into the CDN API. This allows users to set up a logical grouping of endpoints in addition to creating shared configuration settings and selecting pricing tiers and providers.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProfileProperties" + } + } + }, + "ProfileProperties": { + "properties": { + "sku": { + "description": "Profile sku", + "$ref": "#/definitions/Sku" + }, + "resourceState": { + "description": "Resource status of the profile", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfileResourceState", + "modelAsString": false + } + }, + "provisioningState": { + "description": "Provisioning status of the profile", + "$ref": "#/definitions/ProvisioningState" + } + } + }, + "ProfileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "List of CDN Profiles within a resource group" + } + } + }, + "ProfileCreateParameters": { + "type": "object", + "description": "Profile properties required for profile creation", + "required": [ + "location" + ], + "properties": { + "location": { + "description": "Profile location", + "type": "string" + }, + "tags": { + "description": "Profile tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ProfilePropertiesCreateParameters" + } + }, + "x-ms-azure-resource": true + }, + "ProfilePropertiesCreateParameters": { + "required": [ + "sku" + ], + "properties": { + "sku": { + "description": "Profile sku", + "$ref": "#/definitions/Sku" + } + } + }, + "ProfileUpdateParameters": { + "type": "object", + "description": "Profile properties required for profile update", + "required": [ + "tags" + ], + "properties": { + "tags": { + "description": "Profile tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "SsoUri": { + "description": "Sso uri required to login to third party web portal", + "type": "object", + "properties": { + "ssoUri": { + "description": "The uri used to login to third party web portal", + "type": "string" + } + } + }, + "Endpoint": { + "description": "CDN Endpoint is the entity within a CDN Profile containing configuration information regarding caching behaviors and origins. The CDN Endpoint is exposed using the URL format .azureedge.net by default, but custom domains can also be created.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EndpointProperties" + } + } + }, + "EndpointProperties": { + "properties": { + "hostName": { + "description": "The host name of the endpoint {endpointName}.{DNSZone}", + "type": "string", + "readOnly": true + }, + "originHostHeader": { + "description": "The host header CDN provider will send along with content requests to origins. The default value would be the host name of the origin.", + "type": "string" + }, + "originPath": { + "description": "The path used for origin requests", + "type": "string" + }, + "contentTypesToCompress": { + "description": "List of content types on which compression will be applied. The value for the elements should be Internet media type.", + "type": "array", + "items": { + "type": "string" + } + }, + "isCompressionEnabled": { + "description": "Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller than 1 MB.", + "type": "boolean" + }, + "isHttpAllowed": { + "description": "Indicates whether http traffic is allowed on the endpoint. Default value is true. At least one protocol (http or https) must be allowed.", + "type": "boolean" + }, + "isHttpsAllowed": { + "description": "Indicates whether https traffic is allowed on the endpoint. Default value is true. At least one protocol (http or https) must be allowed.", + "type": "boolean" + }, + "queryStringCachingBehavior": { + "description": "Defines the query string caching behavior", + "enum": [ + "IgnoreQueryString", + "BypassCaching", + "UseQueryString" + ], + "type": "string", + "x-ms-enum": { + "name": "QueryStringCachingBehavior", + "modelAsString": false + } + }, + "origins": { + "description": "The set of origins of the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOrigin" + } + }, + "resourceState": { + "description": "Resource status of the endpoint", + "readOnly": true, + "enum": [ + "Creating", + "Deleting", + "Running", + "Starting", + "Stopped", + "Stopping" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointResourceState", + "modelAsString": false + } + }, + "provisioningState": { + "description": "Provisioning status of the endpoint", + "$ref": "#/definitions/ProvisioningState" + } + } + }, + "EndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "List of CDN Endpoints within a profile" + } + } + }, + "EndpointCreateParameters": { + "type": "object", + "description": "Endpoint properties required for new endpoint creation", + "required": [ + "location" + ], + "properties": { + "location": { + "description": "Endpoint location", + "type": "string" + }, + "tags": { + "description": "Endpoint tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/EndpointPropertiesCreateUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "EndpointUpdateParameters": { + "type": "object", + "description": "Endpoint properties required for new endpoint creation", + "properties": { + "tags": { + "description": "Endpoint tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/EndpointPropertiesCreateUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "EndpointPropertiesCreateUpdateParameters": { + "properties": { + "originHostHeader": { + "description": "The host header CDN provider will send along with content requests to origins. The default value would be the host name of the origin.", + "type": "string" + }, + "originPath": { + "description": "The path used for origin requests", + "type": "string" + }, + "contentTypesToCompress": { + "description": "List of content types on which compression will be applied. The value for the elements should be Internet media type.", + "type": "array", + "items": { + "type": "string" + } + }, + "isCompressionEnabled": { + "description": "Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller than 1 MB.", + "type": "boolean" + }, + "isHttpAllowed": { + "description": "Indicates whether http traffic is allowed on the endpoint. Default value is true. At least one protocol (http or https) must be allowed.", + "type": "boolean" + }, + "isHttpsAllowed": { + "description": "Indicates whether https traffic is allowed on the endpoint. Default value is true. At least one protocol (http or https) must be allowed.", + "type": "boolean" + }, + "queryStringCachingBehavior": { + "description": "Sets query string caching behavior", + "enum": [ + "IgnoreQueryString", + "BypassCaching", + "UseQueryString" + ], + "type": "string", + "x-ms-enum": { + "name": "QueryStringCachingBehavior", + "modelAsString": false + } + }, + "origins": { + "description": " The set of origins of the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOrigin" + } + } + } + }, + "DeepCreatedOrigin": { + "description": "Deep created origins within a CDN endpoint", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin name", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/DeepCreatedOriginProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginProperties": { + "description": "Properties of deep created origin on a CDN endpoint", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the origin", + "type": "string" + }, + "httpPort": { + "description": "The value of the http port, must be between 1 and 65535", + "type": "integer" + }, + "httpsPort": { + "description": "The value of the https port, must be between 1 and 65535", + "type": "integer" + } + }, + "x-ms-azure-resource": true + }, + "PurgeParameters": { + "type": "object", + "description": "Parameters required for endpoint purge", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged, can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "LoadParameters": { + "type": "object", + "description": "Parameters required for endpoint load", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be loaded, should describe a file path.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Origin": { + "description": "CDN Origin is the source of the content being delivered via CDN. When the edge nodes represented by an Endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured Origins.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OriginProperties" + } + } + }, + "OriginProperties": { + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the origin", + "type": "string" + }, + "httpPort": { + "description": "The value of the http port, must be between 1 and 65535", + "type": "integer" + }, + "httpsPort": { + "description": "The value of the https port, must be between 1 and 65535", + "type": "integer" + }, + "resourceState": { + "description": "Resource status of the origin", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginResourceState", + "modelAsString": false + } + }, + "provisioningState": { + "description": "Provisioning status of the origin", + "$ref": "#/definitions/ProvisioningState" + } + } + }, + "OriginParameters": { + "type": "object", + "description": "Origin properties needed for origin creation or update", + "properties": { + "properties": { + "$ref": "#/definitions/OriginPropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginPropertiesParameters": { + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the origin", + "type": "string" + }, + "httpPort": { + "description": "The value of the http port, must be between 1 and 65535", + "type": "integer" + }, + "httpsPort": { + "description": "The value of the https port, must be between 1 and 65535", + "type": "integer" + } + } + }, + "OriginListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Origin" + }, + "description": "List of CDN origins within an endpoint" + } + } + }, + "CustomDomain": { + "description": "CDN CustomDomain represents a mapping between a user specified domain name and an Endpoint. It is a common practice to use custom domain names to represent the URLs for branding purposes.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainProperties": { + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain", + "type": "string" + }, + "resourceState": { + "description": "Resource status of the custom domain", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomDomainResourceState", + "modelAsString": false + } + }, + "provisioningState": { + "description": "Provisioning status of the custom domain", + "$ref": "#/definitions/ProvisioningState" + } + } + }, + "CustomDomainParameters": { + "description": "CustomDomain properties required for custom domain creation or update", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CustomDomainPropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "CustomDomainPropertiesParameters": { + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain", + "type": "string" + } + } + }, + "CustomDomainListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "description": "List of CDN CustomDomains within an endpoint." + } + } + }, + "ValidateCustomDomainInput": { + "description": "Input of the custom domain to be validated", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain", + "type": "string" + } + } + }, + "ValidateCustomDomainOutput": { + "description": "Output of custom domain validation", + "type": "object", + "properties": { + "CustomDomainValidated": { + "description": "Indicates whether the custom domain is validated or not", + "type": "boolean" + }, + "Reason": { + "description": "The reason why the custom domain is not valid", + "type": "string" + }, + "Message": { + "description": "The message on why the custom domain is not valid", + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "Input of check name availability API", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated", + "$ref": "#/definitions/ResourceType" + } + } + }, + "CheckNameAvailabilityOutput": { + "description": "Output of check name availability API", + "type": "object", + "properties": { + "NameAvailable": { + "description": "Indicates whether the name is available", + "type": "boolean" + }, + "Reason": { + "description": "The reason why the name is not available", + "type": "string" + }, + "Message": { + "description": "The detailed error message on why the name is not available", + "type": "string" + } + } + }, + "ResourceType": { + "description": "Type of CDN resource used in CheckNameAvailability", + "readOnly": true, + "enum": [ + "Microsoft.Cdn/Profiles/Endpoints" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": false + } + }, + "Operation": { + "description": "CDN REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "properties": { + "provider": { + "description": "Service provider: Microsoft.Cdn", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: profile, endpoint,.. etc", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete,.. etc", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of CDN operations within CDN resource provider." + } + } + }, + "TrackedResource": { + "description": "ARM tracked resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "location", + "tags" + ], + "properties": { + "location": { + "description": "Resource location", + "type": "string" + }, + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Resource": { + "properties": { + "id": { + "description": "Resource Id", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource Name", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type", + "readOnly": true, + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ProvisioningState": { + "description": "Provisioning status of the resource", + "readOnly": true, + "enum": [ + "Creating", + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "Sku": { + "description": "Defines a pricing tier for a profile", + "type": "object", + "properties": { + "name": { + "description": "Name of the resource sku", + "enum": [ + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": false + } + } + } + }, + "ErrorResponse": { + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request, current version is 2015-06-01" + } + } +} \ No newline at end of file diff --git a/arm-compute/2015-06-15/swagger/compute.json b/arm-compute/2015-06-15/swagger/compute.json index f510001e5fec..667bbc6d7607 100644 --- a/arm-compute/2015-06-15/swagger/compute.json +++ b/arm-compute/2015-06-15/swagger/compute.json @@ -173,7 +173,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -215,7 +215,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -816,7 +816,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -852,7 +852,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -1222,7 +1222,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -1634,7 +1634,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -1704,7 +1704,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -2135,7 +2135,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" }, "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" } @@ -2290,7 +2290,7 @@ ], "x-ms-enum": { "name": "StatusLevelTypes", - "modelAsString": "True" + "modelAsString": true } }, "displayStatus": { @@ -2614,7 +2614,7 @@ ], "x-ms-enum": { "name": "OperatingSystemTypes", - "modelAsString": "True" + "modelAsString": true } } }, @@ -2709,7 +2709,7 @@ ], "x-ms-enum": { "name": "UsageUnit", - "modelAsString": "False" + "modelAsString": false } }, "currentValue": { @@ -2873,7 +2873,7 @@ ], "x-ms-enum": { "name": "VirtualMachineSizeTypes", - "modelAsString": "True" + "modelAsString": true } } }, @@ -2970,7 +2970,7 @@ ], "x-ms-enum": { "name": "OperatingSystemTypes", - "modelAsString": "True" + "modelAsString": true } }, "encryptionSettings": { @@ -2999,7 +2999,7 @@ ], "x-ms-enum": { "name": "CachingTypes", - "modelAsString": "True" + "modelAsString": true } }, "createOption": { @@ -3012,7 +3012,7 @@ ], "x-ms-enum": { "name": "DiskCreateOptionTypes", - "modelAsString": "True" + "modelAsString": true } }, "diskSizeGB": { @@ -3057,7 +3057,7 @@ ], "x-ms-enum": { "name": "CachingTypes", - "modelAsString": "True" + "modelAsString": true } }, "createOption": { @@ -3070,7 +3070,7 @@ ], "x-ms-enum": { "name": "DiskCreateOptionTypes", - "modelAsString": "True" + "modelAsString": true } }, "diskSizeGB": { @@ -3117,7 +3117,7 @@ ], "x-ms-enum": { "name": "PassNames", - "modelAsString": "True" + "modelAsString": true } }, "componentName": { @@ -3128,7 +3128,7 @@ ], "x-ms-enum": { "name": "ComponentNames", - "modelAsString": "True" + "modelAsString": true } }, "settingName": { @@ -3140,7 +3140,7 @@ ], "x-ms-enum": { "name": "SettingNames", - "modelAsString": "True" + "modelAsString": true } }, "content": { @@ -3161,7 +3161,7 @@ ], "x-ms-enum": { "name": "ProtocolTypes", - "modelAsString": "True" + "modelAsString": true } }, "certificateUrl": { @@ -3595,7 +3595,7 @@ ], "x-ms-enum": { "name": "UpgradeMode", - "modelAsString": "True" + "modelAsString": true } } }, @@ -3653,7 +3653,7 @@ ], "x-ms-enum": { "name": "CachingTypes", - "modelAsString": "True" + "modelAsString": true } }, "createOption": { @@ -3666,7 +3666,7 @@ ], "x-ms-enum": { "name": "DiskCreateOptionTypes", - "modelAsString": "True" + "modelAsString": true } }, "osType": { @@ -3678,7 +3678,7 @@ ], "x-ms-enum": { "name": "OperatingSystemTypes", - "modelAsString": "True" + "modelAsString": true } }, "image": { @@ -4086,7 +4086,7 @@ ], "x-ms-enum": { "name": "VirtualMachineScaleSetSkuScaleType", - "modelAsString": "True" + "modelAsString": true } } }, @@ -4337,7 +4337,7 @@ ], "x-ms-enum": { "name": "OperationStatus", - "modelAsString": "False" + "modelAsString": false } }, "startTime": { @@ -4388,7 +4388,7 @@ ], "x-ms-enum": { "name": "ComputeOperationStatus", - "modelAsString": "False" + "modelAsString": false } }, "startTime": { diff --git a/arm-datalake-analytics/account/2015-10-01-preview/swagger/account.json b/arm-datalake-analytics/account/2015-10-01-preview/swagger/account.json new file mode 100644 index 000000000000..e491f984c76a --- /dev/null +++ b/arm-datalake-analytics/account/2015-10-01-preview/swagger/account.json @@ -0,0 +1,1529 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataLakeAnalyticsManagementClient", + "description": "Creates an Azure Data Lake Analytics account management client.", + "version": "2015-10-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_GetStorageAccount", + "description": "Gets the specified Azure storage account details in the specified Data Lake Analytics 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 account to retrieve the Azure storage account details from" + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to retrieve" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + } + } + }, + "delete": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_DeleteStorageAccount", + "description": "Updates the Data Lake Analytics account specified to remove the specified Azure 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 Data Lake Analytics account name to remove the Azure Storage account from" + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Storage account to remove" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "patch": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_UpdateStorageAccount", + "description": "Updates the specified storage account. This is currently only supported for Azure blob accounts to update their access keys and suffix.", + "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 Data Lake Analytics account name to modify storage accounts in" + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure Storage account to modify" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AddStorageAccountParameters" + }, + "description": "The parameters containing the access key and suffix to update the storage account with." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "put": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_AddStorageAccount", + "description": "Updates the Data Lake Analytics account specified to include the additional Azure 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 Data Lake Analytics account name to add the Azure Storage account to" + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Storage account to add" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AddStorageAccountParameters" + }, + "description": "The parameters containing the access key and optional suffix for the Azure Storage Account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers/{containerName}": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_GetStorageContainer", + "description": "Gets the specified Azure Storage container object associated with the specified Data Lake Analytics and Azure Storage accounts.", + "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 Data Lake Analytics account to retrieve blob container for" + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage account to retrieve the blob container from" + }, + { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage container to retrieve" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/BlobContainer" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_ListStorageContainers", + "description": "Gets the Azure Storage containers object associated with the specified Data Lake Analytics and Azure Storage accounts.", + "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 Data Lake Analytics account to retrieve blob containers for" + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage account to retrieve blob containers from" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListBlobContainersResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{nextLink}": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_StorageContainersListNext", + "description": "Gets the next page of the Azure Storage Container objects within the specified Azure Storage account, if any.", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "The url to the next Azure Storage Container page.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListBlobContainersResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_SasTokensListNext", + "description": "Gets the next page of the SAS token objects within the specified Azure Storage account and container, if any.", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "The url to the next Azure Storage Container SAS token page.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListSasTokensResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/{storageAccountName}/Containers/{containerName}/listSasTokens": { + "post": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_ListSasTokens", + "description": "Gets the SAS token associated with the specified Data Lake Analytics and WASB storage account and container combination.", + "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 Data Lake Analytics account to get the SAS token for" + }, + { + "name": "storageAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage account to retrieve the blob container from" + }, + { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure storage container to retrieve" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListSasTokensResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/DataLakeStoreAccounts/{dataLakeStoreAccountName}": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_GetDataLakeStoreAccount", + "description": "Gets the specified Data Lake Store account details in the specified Data Lake Analytics 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 account to retrieve the Data Lake Store account details from" + }, + { + "name": "dataLakeStoreAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to retrieve" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + } + } + }, + "delete": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_DeleteDataLakeStoreAccount", + "description": "Updates the Data Lake Analytics account specified to remove the specified Data Lake Store 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 Data Lake Analytics account name to remove the Data Lake Store account from" + }, + { + "name": "dataLakeStoreAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to remove" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "put": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_AddDataLakeStoreAccount", + "description": "Updates the Data Lake Analytics account specified to include the additional Data Lake Store 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 Data Lake Analytics account name to add the Data Lake Store account to" + }, + { + "name": "dataLakeStoreAccountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to add" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/AddDataLakeStoreParameters" + }, + "description": "The parameters containing the optional properties associated with the named Data Lake account." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/StorageAccounts/": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_ListStorageAccounts", + "description": "Gets the first page of the Data Lake Analytics account objects within the subscription or within a specific resource group. This includes a link to the next page, if any.", + "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 Data Lake Analytics account to list Storage accounts for." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "name": "$search", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets a free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional." + }, + { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccountListStorageAccountsResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/StorageAccount" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}/DataLakeStoreAccounts/": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_ListDataLakeStoreAccounts", + "description": "Gets the first page of the Data Lake Store account objects within the specified Data Lake Analytics account. This includes a link to the next page, if any.", + "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 Data Lake Analytics account to list Data Lake Store accounts for." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "name": "$search", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets a free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional." + }, + { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccountListDataLakeStoreResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DataLakeStoreAccount" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_List", + "description": "Gets the first page of the Data Lake Analytics account objects within the subscription or within a specific resource group. This includes a link to the next page, if any.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "name": "$search", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets a free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional." + }, + { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DataLakeAnalyticsAccount" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{accountName}": { + "get": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_Get", + "description": "Gets the Data Lake Analytics account object specified by the account name.", + "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 account to retrieve" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + } + } + }, + "delete": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_Delete", + "description": "Begins the delete delete process for the Data Lake Analytics account object specified by the account name.", + "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 account to delete" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "202": { + "description": "" + }, + "404": { + "description": "" + }, + "204": { + "description": "" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeAnalytics/accounts/{name}": { + "put": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_Create", + "description": "Begins the creation process for the specified Data Lake Analytics account.This supplies the user with computation services for Data Lake Analytics workloads", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the account will be associated with." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to create." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + }, + "description": "Parameters supplied to the create Data Lake Analytics account operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DataLakeAnalyticsAccount" + ], + "operationId": "DataLakeAnalyticsAccount_Update", + "description": "Updates the Data Lake Analytics account object specified by the accountName with the contents of the account object.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + }, + "description": "Parameters supplied to the update Data Lake Analytics account operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "StorageAccountProperties": { + "properties": { + "accessKey": { + "type": "string", + "description": "Gets or sets the access key associated with this Azure Storage account that will be used to connect to it." + }, + "suffix": { + "type": "string", + "description": "Gets or sets the optional suffix for the Data Lake account." + } + }, + "description": "Azure Storage account properties information." + }, + "StorageAccount": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the account name associated with the Azure storage account." + }, + "properties": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "Gets or sets the properties associated with this storage account." + } + }, + "description": "Azure Storage account information." + }, + "BlobContainerProperties": { + "properties": { + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last modified time of the blob container." + } + }, + "description": "Azure Storage blob container properties information." + }, + "BlobContainer": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the blob container." + }, + "id": { + "type": "string", + "description": "Gets or sets the unique identifier of the blob container." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the blob container." + }, + "properties": { + "$ref": "#/definitions/BlobContainerProperties", + "description": "Gets or sets the properties of the blob container." + } + }, + "description": "Azure Storage blob container information." + }, + "ListBlobContainersResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BlobContainer" + }, + "description": "Gets or set the results of the list operation" + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link (url) to the next page of results." + } + }, + "description": "The list of blob containers associated with the storage account attached to the Data Lake Analytics account." + }, + "SasTokenInfo": { + "properties": { + "accessToken": { + "type": "string", + "description": "Gets or sets the access token for the associated Azure Storage Container." + } + }, + "description": "SAS token information." + }, + "ListSasTokensResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SasTokenInfo" + } + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link (url) to the next page of results." + } + }, + "description": "The SAS response that contains the storage account, container and associated SAS token for connection use." + }, + "DataLakeStoreAccountProperties": { + "properties": { + "suffix": { + "type": "string", + "description": "Gets or sets the optional suffix for the Data Lake Store account." + } + }, + "description": "Data Lake Store account properties information." + }, + "DataLakeStoreAccount": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the account name of the Data Lake Store account." + }, + "properties": { + "$ref": "#/definitions/DataLakeStoreAccountProperties", + "description": "Gets or sets the properties associated with this Data Lake Store account." + } + }, + "description": "Data Lake Store account information." + }, + "DataLakeAnalyticsAccountListStorageAccountsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets or set the results of the list operation" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets total number of results." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link (url) to the next page of results." + } + }, + "description": "Azure Storage Account list information." + }, + "DataLakeAnalyticsAccountListDataLakeStoreResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataLakeStoreAccount" + }, + "description": "Gets or set the results of the list operation" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets total number of results." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link (url) to the next page of results." + } + }, + "description": "Data Lake Account list information." + }, + "DataLakeAnalyticsAccountProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the provisioning status of the Data Lake Analytics account.", + "enum": [ + "Failed", + "Creating", + "Running", + "Succeeded", + "Patching", + "Suspending", + "Resuming", + "Deleting", + "Deleted" + ], + "x-ms-enum": { + "name": "DataLakeAnalyticsAccountStatus", + "modelAsString": false + } + }, + "state": { + "readOnly": true, + "type": "string", + "description": "Gets the state of the Data Lake Analytics account.", + "enum": [ + "active", + "suspended" + ], + "x-ms-enum": { + "name": "DataLakeAnalyticsAccountState", + "modelAsString": false + } + }, + "defaultDataLakeStoreAccount": { + "type": "string", + "description": "Gets or sets the default data lake storage account associated with this Data Lake Analytics account." + }, + "maxDegreeOfParallelism": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the maximum supported degree of parallelism for this acocunt." + }, + "maxJobCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the maximum supported jobs running under the account at the same time." + }, + "dataLakeStoreAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/DataLakeStoreAccount" + }, + "description": "Gets or sets the list of Data Lake storage accounts associated with this account." + }, + "storageAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "Gets or sets the list of Azure Blob storage accounts associated with this account." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the account creation time." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the account last modified time." + }, + "endpoint": { + "type": "string", + "description": "Gets or sets the full CName endpoint for this account." + } + }, + "description": "The account specific properties that are associated with an underlying Data Lake Analytics account." + }, + "AddDataLakeStoreParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/DataLakeStoreAccountProperties", + "description": "Gets or sets the properties for the Data Lake Store account being added." + } + }, + "description": "Additional Data Lake Store parameters." + }, + "AddStorageAccountParameters": { + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "Gets or sets the properties for the Azure Storage account being added." + } + }, + "description": "Additional Azure Storage account parameters." + }, + "DataLakeAnalyticsAccount": { + "properties": { + "location": { + "type": "string", + "description": "Gets or sets the account regional location." + }, + "name": { + "type": "string", + "description": "Gets or sets the account name." + }, + "type": { + "type": "string", + "description": "Gets or sets the namespace and type of the account." + }, + "id": { + "type": "string", + "description": "Gets or sets the account subscription ID." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the value of custom properties." + }, + "properties": { + "$ref": "#/definitions/DataLakeAnalyticsAccountProperties", + "description": "Gets or sets the properties defined by Data Lake Analytics all properties are specific to each resource provider." + } + }, + "description": "A Data Lake Analytics account object, containing all information associated with the named Data Lake Analytics account." + }, + "DataLakeAnalyticsAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataLakeAnalyticsAccount" + }, + "description": "Gets or set the results of the list operation" + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link (url) to the next page of results." + } + }, + "description": "DataLakeAnalytics Account list information." + }, + "ErrorDetails": { + "properties": { + "code": { + "type": "string", + "description": "Gets or sets the HTTP status code or error code associated with this error" + }, + "message": { + "type": "string", + "description": "Gets or sets the error message localized based on Accept-Language" + }, + "target": { + "type": "string", + "description": "Gets or sets the target of the particular error (for example, the name of the property in error)." + } + }, + "description": "Generic resource error details information." + }, + "InnerError": { + "properties": { + "trace": { + "type": "string", + "description": "Gets or sets the stack trace for the error" + }, + "context": { + "type": "string", + "description": "Gets or sets the context for the error message" + } + }, + "description": "Generic resource inner error information." + }, + "Error": { + "properties": { + "code": { + "type": "string", + "description": "Gets or sets the HTTP status code or error code associated with this error" + }, + "message": { + "type": "string", + "description": "Gets or sets the error message to display." + }, + "target": { + "type": "string", + "description": "Gets or sets the target of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "description": "Gets or sets the list of error details" + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "description": "Gets or sets the inner exceptions or errors, if any" + } + }, + "required": [ + "code", + "message" + ], + "description": "Generic resource error information." + }, + "AzureAsyncOperationResult": { + "properties": { + "status": { + "type": "string", + "description": "Gets or sets the status of the AzureAsuncOperation", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + } + }, + "error": { + "$ref": "#/definitions/Error" + } + }, + "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." + }, + "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-datalake-analytics/catalog/2015-10-01-preview/swagger/catalog.json b/arm-datalake-analytics/catalog/2015-10-01-preview/swagger/catalog.json new file mode 100644 index 000000000000..a5b54d436b93 --- /dev/null +++ b/arm-datalake-analytics/catalog/2015-10-01-preview/swagger/catalog.json @@ -0,0 +1,3121 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataLakeAnalyticsCatalogManagementClient", + "description": "Creates an Azure Data Lake Analytics catalog management client.", + "version": "2015-10-01-preview" + }, + "host": "accountname.catalogserviceuri", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "paths": { + "/catalog/usql/databases/{databaseName}/secrets/{secretName}": { + "put": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_CreateSecret", + "description": "Creates the specified secret for use with external data sources in the specified database", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to create the secret in." + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "description": "The parameters required to create the secret (name and password)" + }, + + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters" + }, + "description": "The parameters required to create the secret (name and password)" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlSecret" + } + } + } + }, + "patch": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_UpdateSecret", + "description": "Modifies the specified secret for use with external data sources in the specified database", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to modify the secret in." + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "description": "The parameters required to modify the secret (name and password)" + }, + + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters" + }, + "description": "The parameters required to modify the secret (name and password)" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlSecret" + } + } + } + }, + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetSecret", + "description": "Gets the specified secret in the specified database", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to get the secret from." + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret to get" + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlSecret" + } + } + } + }, + "delete": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_DeleteSecret", + "description": "Deletes the specified secret in the specified database", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to delete the secret from." + }, + { + "name": "secretName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the secret to delete" + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/catalog/usql/databases/{databaseName}/externaldatasources/{externalDataSourceName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetExternalDataSource", + "description": "Retrieves the specified external data source from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the external Data Source in." + }, + { + "name": "externalDataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the external Data Source to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlExternalDataSource" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/externaldatasources": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListExternalDataSources", + "description": "Retrieves the list of external data sources from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the external Data Source in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlExternalDataSourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}/credentials/{credentialName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetCredential", + "description": "Retrieves the specified credential from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the schema in." + }, + { + "name": "credentialName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the credential to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlCredential" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/credentials": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListCredentials", + "description": "Retrieves the list of credentials from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the schema in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlCredentialList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures/{procedureName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetProcedure", + "description": "Retrieves the specified procedure from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the procedure in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the procedure in." + }, + { + "name": "procedureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the procedure to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlProcedure" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListProcedures", + "description": "Retrieves the list of procedures from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the procedures in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the procedures in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlProcedureList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetTable", + "description": "Retrieves the specified table from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the table in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the table in." + }, + { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the table to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlTable" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListTables", + "description": "Retrieves the list of tables from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the tables in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the tables in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlTableList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/views/{viewName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetView", + "description": "Retrieves the specified view from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the view in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the view in." + }, + { + "name": "viewName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the view to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlView" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/views": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListViews", + "description": "Retrieves the list of views from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the views in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the views in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlViewList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics/{statisticsName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetTableStatistic", + "description": "Retrieves the specified table from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the statistics in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the statistics in." + }, + { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the table to find the statistics in." + }, + { + "name": "statisticsName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the table statistics to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlTableStatistics" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListTableStatistics", + "description": "Retrieves the list of tables from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the statistics in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the statistics in." + }, + { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the table to find the statistics in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlTableStatisticsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/types": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListTypes", + "description": "Retrieves the list of catalog types within the specified database and schema for the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the types in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the types in." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlTypeList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/USqlType" + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions/{tableValuedFunctionName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetTableValuedFunction", + "description": "Retrieves the specified table valued function from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the table valued function in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the table valued function in." + }, + { + "name": "tableValuedFunctionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tableValuedFunction to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlTableValuedFunction" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListTableValuedFunctions", + "description": "Retrieves the list of table valued functions from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the table valued functions in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find the table valued functions in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlTableValuedFunctionList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}/assemblies/{assemblyName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetAssembly", + "description": "Retrieves the specified assembly from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the assembly in." + }, + { + "name": "assemblyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the assembly to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlAssembly" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/assemblies": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListAssemblies", + "description": "Retrieves the list of assemblies from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the assembly in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlAssemblyList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas/{schemaName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetSchema", + "description": "Retrieves the specified schema from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the schema in." + }, + { + "name": "schemaName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schema to find." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlSchema" + } + } + } + } + }, + "/catalog/usql/databases/{databaseName}/schemas": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListSchemas", + "description": "Retrieves the list of schemas from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database to find the schema in." + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlSchemaList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/catalog/usql/databases/{databaseName}": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_GetDatabase", + "description": "Retrieves the specified database from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to create." + }, + + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlDatabase" + } + } + } + } + }, + "/catalog/usql/databases": { + "get": { + "tags": [ + "Catalog" + ], + "operationId": "Catalog_ListDatabases", + "description": "Retrieves the list of databases from the current Data Lake Analytics catalog", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/catalogServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/USqlDatabaseList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters": { + "properties": { + "password": { + "type": "string", + "description": "Gets or sets the password for the secret to pass in" + }, + "uri": { + "type": "string", + "description": "Gets or sets the URI identifier for the secret in the format :" + } + }, + "required": [ + "password" + ], + "description": "DataLakeAnalytics DataLakeAnalyticsAccount information." + }, + "USqlSecret": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "secretName": { + "type": "string", + "description": "Gets or sets the name of the secret." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time of the credential object. This is the only information returned about a secret from a GET." + }, + "uri": { + "type": "string", + "description": "Gets or sets the URI identifier for the secret in the format :" + }, + "password": { + "type": "string", + "description": "Gets or sets the password for the secret to pass in" + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL secret item." + }, + "USqlExternalDataSource": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "externalDataSourceName": { + "type": "string", + "description": "Gets or sets the name of the external data source." + }, + "provider": { + "type": "string", + "description": "Gets or sets the name of the provider for the external data source." + }, + "providerString": { + "type": "string", + "description": "Gets or sets the name of the provider string for the external data source." + }, + "pushdownTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the list of types to push down from the external data source." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL external datasource item." + }, + "USqlExternalDataSourceList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlExternalDataSource" + }, + "description": "Gets or sets the list of external data sources in the database" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL external datasource item list." + }, + "USqlCredential": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database the credential is in." + }, + "identity": { + "type": "string", + "description": "Gets or sets the name of the secret associated with the credential." + }, + "credentialName": { + "type": "string", + "description": "Gets or sets the name of the credential." + }, + "userName": { + "type": "string", + "description": "Gets or sets the user name associated with the credential." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL credential item." + }, + "USqlCredentialList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlCredential" + }, + "description": "Gets or sets the list of credentials in the database" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL credential item list." + }, + "USqlProcedure": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "schemaName": { + "type": "string", + "description": "Gets or sets the name of the schema associated with this procedure and database." + }, + "procName": { + "type": "string", + "description": "Gets or sets the name of the procedure." + }, + "definition": { + "type": "string", + "description": "Gets or sets the defined query of the procedure." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL procedure item." + }, + "USqlProcedureList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlProcedure" + }, + "description": "Gets or sets the list of procedure in the database and schema combination" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL procedure item list." + }, + "USqlTableColumn": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the column in the table." + }, + "type": { + "type": "string", + "description": "Gets or sets the object type of the specified column (such as System.String)." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table column item." + }, + "USqlDirectedColumn": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the index in the table." + }, + "descending": { + "type": "boolean", + "description": "Gets or sets the switch indicating if the index is descending or not." + } + }, + "description": "A Data Lake Analytics catalog U-SQL directed column item." + }, + "USqlDistributionInfo": { + "properties": { + "type": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the type of this distribution." + }, + "keys": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlDirectedColumn" + }, + "description": "Gets or sets the list of directed columns in the distribution" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of indices using this distribution." + }, + "dynamicCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the dynamic count of indices using this distribution." + } + }, + "description": "A Data Lake Analytics catalog U-SQL distribution information object." + }, + "USqlIndex": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the index in the table." + }, + "indexKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlDirectedColumn" + }, + "description": "Gets or sets the list of directed columns in the index" + }, + "columns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the list of columns in the index" + }, + "distributionInfo": { + "$ref": "#/definitions/USqlDistributionInfo", + "description": "Gets or sets the distributions info of the index" + }, + "partitionFunction": { + "type": "string", + "description": "Gets or sets partition function ID for the index." + }, + "partitionKeyList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the list of partion keys in the index" + }, + "streamNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the list of full paths to the streams that contain this index in the DataLake account." + }, + "isColumnstore": { + "type": "boolean", + "description": "Gets or sets the switch indicating if this index is a columnstore index." + }, + "indexId": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the ID of this index within the table." + }, + "isUnique": { + "type": "boolean", + "description": "Gets or sets the switch indicating if this index is a unique index." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table index item." + }, + "DdlName": { + "properties": { + "firstPart": { + "type": "string", + "description": "Gets or sets the name of the table associated with this database and schema." + }, + "secondPart": { + "type": "string", + "description": "Gets or sets the name of the table associated with this database and schema." + }, + "thirdPart": { + "type": "string", + "description": "Gets or sets the name of the table associated with this database and schema." + }, + "server": { + "type": "string", + "description": "Gets or sets the name of the table associated with this database and schema." + } + }, + "description": "A Data Lake Analytics DDL name item." + }, + "EntityId": { + "properties": { + "name": { + "$ref": "#/definitions/DdlName", + "description": "Gets or sets the name of the external table associated with this database, schema and table." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the external data source." + } + }, + "description": "A Data Lake Analytics catalog entity identifier object." + }, + "ExternalTable": { + "properties": { + "tableName": { + "type": "string", + "description": "Gets or sets the name of the table associated with this database and schema." + }, + "dataSource": { + "$ref": "#/definitions/EntityId", + "description": "Gets or sets the data source associated with this external table." + } + }, + "description": "A Data Lake Analytics catalog external table item." + }, + "USqlTable": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "schemaName": { + "type": "string", + "description": "Gets or sets the name of the schema associated with this table and database." + }, + "tableName": { + "type": "string", + "description": "Gets or sets the name of the table." + }, + "columnList": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlTableColumn" + }, + "description": "Gets or sets the list of columns in this table" + }, + "indexList": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlIndex" + }, + "description": "Gets or sets the list of indices in this table" + }, + "partitionKeyList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the list of partition keys in the table" + }, + "externalTable": { + "$ref": "#/definitions/ExternalTable", + "description": "Gets or sets the external table associated with the table." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table item." + }, + "USqlTableList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlTable" + }, + "description": "Gets or sets the list of tables in the database and schema combination" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table item list." + }, + "USqlView": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "schemaName": { + "type": "string", + "description": "Gets or sets the name of the schema associated with this view and database." + }, + "viewName": { + "type": "string", + "description": "Gets or sets the name of the view." + }, + "definition": { + "type": "string", + "description": "Gets or sets the defined query of the view." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL view item." + }, + "USqlViewList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlView" + }, + "description": "Gets or sets the list of view in the database and schema combination" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL view item list." + }, + "USqlTableStatistics": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "schemaName": { + "type": "string", + "description": "Gets or sets the name of the schema associated with this table and database." + }, + "tableName": { + "type": "string", + "description": "Gets or sets the name of the table." + }, + "statisticsName": { + "type": "string", + "description": "Gets or sets the name of the table statistics." + }, + "userStatName": { + "type": "string", + "description": "Gets or sets the name of the user statistics." + }, + "statDataPath": { + "type": "string", + "description": "Gets or sets the path to the statistics data." + }, + "createTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the creation time of the statistics." + }, + "updateTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last time the statistics were updated." + }, + "isUserCreated": { + "type": "boolean", + "description": "Gets or sets the switch indicating if these statistics are user created." + }, + "isAutoCreated": { + "type": "boolean", + "description": "Gets or sets the switch indicating if these statistics are automatically created." + }, + "hasFilter": { + "type": "boolean", + "description": "Gets or sets the switch indicating if these statistics have a filter." + }, + "filterDefinition": { + "type": "string", + "description": "Gets or sets the filter definition for the statistics." + }, + "colNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the list of column names associated with these statistics." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table statistics item." + }, + "USqlTableStatisticsList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlTableStatistics" + }, + "description": "Gets or sets the list of table statistics in the database, schema and table combination" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table statistics item list." + }, + "USqlType": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "schemaName": { + "type": "string", + "description": "Gets or sets the name of the schema associated with this table and database." + }, + "typeName": { + "type": "string", + "description": "Gets or sets the name of type for this type." + }, + "typeFamily": { + "type": "string", + "description": "Gets or sets the type family for this type." + }, + "cSharpName": { + "type": "string", + "description": "Gets or sets the C# name for this type." + }, + "fullCSharpName": { + "type": "string", + "description": "Gets or sets the fully qualified C# name for this type." + }, + "systemTypeId": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the system type ID for this type." + }, + "userTypeId": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the user type ID for this type." + }, + "schemaId": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the schema ID for this type." + }, + "principalId": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the principal ID for this type." + }, + "isNullable": { + "type": "boolean", + "description": "Gets or sets the the switch indicating if this type is nullable." + }, + "isUserDefined": { + "type": "boolean", + "description": "Gets or sets the the switch indicating if this type is user defined." + }, + "isAssemblyType": { + "type": "boolean", + "description": "Gets or sets the the switch indicating if this type is an assembly type." + }, + "isTableType": { + "type": "boolean", + "description": "Gets or sets the the switch indicating if this type is a table type." + }, + "isComplexType": { + "type": "boolean", + "description": "Gets or sets the the switch indicating if this type is a complex type." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL type item." + }, + "USqlTypeList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlType" + }, + "description": "Gets or sets the list of types in the database and schema combination" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL type item list." + }, + "USqlTableValuedFunction": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "schemaName": { + "type": "string", + "description": "Gets or sets the name of the schema associated with this database." + }, + "tvfName": { + "type": "string", + "description": "Gets or sets the name of the table valued function." + }, + "definition": { + "type": "string", + "description": "Gets or sets the definition of the table valued function." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table valued function item." + }, + "USqlTableValuedFunctionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlTableValuedFunction" + }, + "description": "Gets or sets the list of table valued functions in the database and schema combination" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL table valued function item list." + }, + "USqlAssemblyFileInfo": { + "properties": { + "type": { + "type": "string", + "description": "Gets or sets the assembly file type.", + "enum": [ + "Assembly", + "Resource" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": false + } + }, + "originalPath": { + "type": "string", + "description": "Gets or sets the the original path to the assembly file." + }, + "contentPath": { + "type": "string", + "description": "Gets or sets the the content path to the assembly file." + } + }, + "description": "A Data Lake Analytics catalog U-SQL assembly file information item." + }, + "USqlAssemblyDependencyInfo": { + "properties": { + "entityId": { + "$ref": "#/definitions/EntityId", + "description": "Gets or sets the EntityId of the dependency." + } + }, + "description": "A Data Lake Analytics catalog U-SQL dependency information item." + }, + "USqlAssembly": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "assemblyName": { + "type": "string", + "description": "Gets or sets the name of the assembly." + }, + "clrName": { + "type": "string", + "description": "Gets or sets the name of the CLR." + }, + "isVisible": { + "type": "boolean", + "description": "Gets or sets the switch indicating if this assembly is visible or not." + }, + "isUserDefined": { + "type": "boolean", + "description": "Gets or sets the switch indicating if this assembly is user defined or not." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlAssemblyFileInfo" + }, + "description": "Gets or sets the list of files associated with the assembly" + }, + "dependencies": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlAssemblyDependencyInfo" + }, + "description": "Gets or sets the list of dependencies associated with the assembly" + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL Assembly." + }, + "USqlAssemblyClr": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "assemblyClrName": { + "type": "string", + "description": "Gets or sets the name of the assembly." + }, + "clrName": { + "type": "string", + "description": "Gets or sets the name of the CLR." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL assembly CLR item." + }, + "USqlAssemblyList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlAssemblyClr" + }, + "description": "Gets or sets the list of assemblies in the database" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL assembly CLR item list." + }, + "USqlSchema": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "schemaName": { + "type": "string", + "description": "Gets or sets the name of the schema." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL schema item." + }, + "USqlSchemaList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlSchema" + }, + "description": "Gets or sets the list of schemas in the database" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL schema item list." + }, + "USqlDatabase": { + "properties": { + "databaseName": { + "type": "string", + "description": "Gets or sets the name of the database." + }, + "computeAccountName": { + "type": "string", + "description": "Gets or sets the name of the Data Lake Analytics account." + }, + "version": { + "type": "string", + "description": "Gets or sets the version of the catalog item." + } + }, + "description": "A Data Lake Analytics catalog U-SQL database item." + }, + "USqlDatabaseList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/USqlDatabase" + }, + "description": "Gets or sets the list of databases" + }, + "itemType": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or USql).", + "enum": [ + "usqlDatabase", + "usqlSchema", + "usqlAssembly", + "usqlTable", + "uSqlView", + "uSqlProcedure", + "uSqlCredential", + "usqlTableValuedFunction", + "usqlTableStatistics", + "usqlSecret", + "usqlExternalDataSource", + "usqlType" + ], + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the count of items in the list." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link to the next page of results." + } + }, + "description": "A Data Lake Analytics catalog U-SQL database item list." + }, + "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": "header", + "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." + }, + "catalogServiceUriInPathParameter": { + "name": "catalogserviceuri", + "in": "path", + "required": true, + "type": "string", + "default": "\"azuredatalakeanalytics.net\"", + "description": "Gets the URI used as the base for all cloud service requests." + } + } +} \ No newline at end of file diff --git a/arm-datalake-analytics/job/2015-10-01-preview/swagger/job.json b/arm-datalake-analytics/job/2015-10-01-preview/swagger/job.json new file mode 100644 index 000000000000..a27ab127333d --- /dev/null +++ b/arm-datalake-analytics/job/2015-10-01-preview/swagger/job.json @@ -0,0 +1,930 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataLakeAnalyticsJobManagementClient", + "description": "Creates an Azure Data Lake Analytics job management client.", + "version": "2015-10-01-preview" + }, + "host": "accountname.jobserviceuri", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "paths": { + "/Jobs/{jobIdentity}/GetStatistics": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_GetStatistics", + "description": "Gets the job statistics object specified by the job ID.", + "parameters": [ + + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to get the job from" + }, + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "description": "JobInfo ID." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/jobServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/JobStatistics" + } + } + } + } + }, + "/Jobs/{jobIdentity}/GetDebugDataPath": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_GetDebugDataPath", + "description": "Gets the U-SQL job debug data information specified by the job ID.", + "parameters": [ + + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to get the job from" + }, + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "description": "JobInfo ID." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/jobServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/JobDataPath" + } + } + } + } + }, + "/BuildJob": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Build", + "description": "Builds (compiles) the specified job in the specified Data Lake Analytics account for job correctness and validation.", + "parameters": [ + + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to build the job for" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobInformation" + }, + "description": "The parameters to build a job, which simulates submission." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/jobServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/JobInformation" + } + } + } + } + }, + "/Jobs/{jobId}": { + "put": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Create", + "description": "Submits the specified job to the specified Data Lake Analytics account for computation.", + "parameters": [ + + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to create the job for" + }, + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The parameters to submit a job." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobInformation" + }, + "description": "The parameters to submit a job." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/jobServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/JobInformation" + } + } + } + } + }, + "/Jobs/{jobIdentity}/CancelJob": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Cancel", + "description": "Cancels the running job specified by the job ID.", + "parameters": [ + + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to cancel the job for" + }, + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "description": "JobInfo ID to cancel." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/jobServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/Jobs/{jobIdentity}": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_Get", + "description": "Gets the JobInfo object specified by the job ID.", + "parameters": [ + + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to get the job from" + }, + { + "name": "jobIdentity", + "in": "path", + "required": true, + "type": "string", + "description": "JobInfo ID." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/jobServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/JobInformation" + } + } + } + } + }, + "/Jobs": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Jobs_List", + "description": "Gets the first page of the Data Lake Analytics JobInformation objects within the specified resource group with a link to the next page, if any.", + "parameters": [ + + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Analytics account to get the job from" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "name": "$search", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets a free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional." + }, + { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/jobServiceUriInPathParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/JobInfoListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/JobInformation" + } + } + }, + "definitions": { + "JobStatisticsVertexStage": { + "properties": { + "dataRead": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the amount of data read, in bytes." + }, + "dataReadCrossPod": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the amount of data read across multiple pods, in bytes." + }, + "dataReadIntraPod": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the amount of data read in one pod, in bytes." + }, + "dataToRead": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the amount of data remaining to be read, in bytes." + }, + "dataWritten": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the amount of data written, in bytes." + }, + "duplicateDiscardCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of duplicates that were discarded." + }, + "failedCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of failures that occured in this stage." + }, + "maxVertexDataRead": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the maximum amount of data read in a single vertex, in bytes." + }, + "minVertexDataRead": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the minimum amount of data read in a single vertex, in bytes." + }, + "readFailureCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of read failures in this stage." + }, + "revocationCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of vertices that were revoked during this stage." + }, + "runningCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of currently running vertices in this stage." + }, + "scheduledCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of currently scheduled vertices in this stage" + }, + "stageName": { + "type": "string", + "description": "Gets or sets the name of this stage in job execution." + }, + "succeededCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of vertices that succeeded in this stage." + }, + "tempDataWritten": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the amount of temporary data written, in bytes." + }, + "totalCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the total vertex count for this stage." + }, + "totalFailedTime": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the amount of time that failed vertices took up in this stage." + }, + "totalProgress": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the current progress of this stage, as a percentage." + }, + "totalSucceededTime": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the amount of time all successful vertices took in this stage." + } + }, + "description": "The Data Lake Analytics U-SQL job statistics vertex stage information." + }, + "JobStatistics": { + "properties": { + "lastUpdateTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the last update time for the statistics." + }, + "stages": { + "type": "array", + "items": { + "$ref": "#/definitions/JobStatisticsVertexStage" + }, + "description": "Gets or sets the list of stages for the job." + } + }, + "description": "The Data Lake Analytics U-SQL job execution statistics." + }, + "JobDataPath": { + "properties": { + "jobId": { + "type": "string", + "description": "Gets or sets the id of the job this data is for." + }, + "command": { + "type": "string", + "description": "Gets or sets the command that this job data relates to." + }, + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the list of paths to all of the job data." + } + }, + "description": "A Data Lake Analytics U-SQL job data path item." + }, + "JobStateAuditRecord": { + "properties": { + "newState": { + "type": "string", + "description": "Gets or sets the new state the job is in." + }, + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time stamp that the state change took place." + }, + "requestedByUser": { + "type": "string", + "description": "Gets or sets the user who requests the change." + }, + "details": { + "type": "string", + "description": "Gets or sets the details of the audit log." + } + }, + "description": "The Data Lake Analytics U-SQL job state audit records for tracking the lifecycle of a job." + }, + "JobResource": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name of the resource." + }, + "resourcePath": { + "type": "string", + "description": "Gets or sets the path to the resource." + }, + "type": { + "type": "string", + "description": "Gets or sets the job resource type.", + "enum": [ + "VertexResource", + "StatisticsResource" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + } + }, + "description": "The Data Lake Analytics U-SQL job resources." + }, + "USqlProperties": { + "x-ms-discriminator-value": "USql", + "allOf": [ + { + "$ref": "#/definitions/JobProperties" + } + ], + "properties": { + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + }, + "description": "Gets or sets the list of resources that are required by the job" + }, + "statistics": { + "$ref": "#/definitions/JobStatistics", + "description": "Gets or sets the job specific statistics." + }, + "debugData": { + "$ref": "#/definitions/JobDataPath", + "description": "Gets or sets the job specific debug data locations." + }, + "algebraFilePath": { + "type": "string", + "description": "Gets or sets the U-SQL algebra file path after the job has completed" + }, + "totalCompilationTime": { + "type": "string", + "description": "Gets or sets the total time this job spent compiling. This value should not be set by the user and will be ignored if it is." + }, + "totalPauseTime": { + "type": "string", + "description": "Gets or sets the total time this job spent paused. This value should not be set by the user and will be ignored if it is." + }, + "totalQueuedTime": { + "type": "string", + "description": "Gets or sets the total time this job spent queued. This value should not be set by the user and will be ignored if it is." + }, + "totalRunningTime": { + "type": "string", + "description": "Gets or sets the total time this job spent executing. This value should not be set by the user and will be ignored if it is." + }, + "rootProcessNodeId": { + "type": "string", + "description": "Gets or sets the ID used to identify the job manager coordinating job execution. This value should not be set by the user and will be ignored if it is." + }, + "yarnApplicationId": { + "type": "string", + "description": "Gets or sets the ID used to identify the yarn application executing the job. This value should not be set by the user and will be ignored if it is." + }, + "yarnApplicationTimeStamp": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the timestamp (in ticks) for the yarn application executing the job. This value should not be set by the user and will be ignored if it is." + }, + "compileMode": { + "type": "string", + "description": "Gets or sets the compile mode for the job.", + "enum": [ + "Semantic", + "Full", + "SingleBox" + ], + "x-ms-enum": { + "name": "CompileMode", + "modelAsString": true + } + } + } + }, + "HiveJobStatementInfo": { + "properties": { + "logLocation": { + "type": "string", + "description": "Gets or sets the log location for this statement." + }, + "resultPreviewLocation": { + "type": "string", + "description": "Gets or sets the result preview location for this statement." + }, + "resultLocation": { + "type": "string", + "description": "Gets or sets the result location for this statement." + }, + "errorMessage": { + "type": "string", + "description": "Gets or sets the error message for this statement." + } + } + }, + "HiveProperties": { + "x-ms-discriminator-value": "Hive", + "allOf": [ + { + "$ref": "#/definitions/JobProperties" + } + ], + "properties": { + "statementInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/HiveJobStatementInfo" + }, + "description": "Gets or sets the statement information for each statement in the script" + }, + "logsLocation": { + "type": "string", + "description": "Gets or sets the Hive logs location" + }, + "warehouseLocation": { + "type": "string", + "description": "Gets or sets the runtime version of the U-SQL engine to use" + }, + "statementCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of statements that will be run based on the script" + }, + "executedStatementCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of statements that have been run based on the script" + } + } + }, + "JobProperties": { + "discriminator": "type", + "required": [ + "script", + "type" + ], + "properties": { + "runtimeVersion": { + "type": "string", + "description": "Gets or sets the runtime version of the U-SQL engine to use" + }, + "script": { + "type": "string", + "description": "Gets or sets the U-SQL script to run" + }, + "type": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or U-SQL)." + } + }, + "description": "The common Data Lake Analytics job properties." + }, + "JobInformation": { + "properties": { + "jobId": { + "type": "string", + "description": "Gets or sets the job's unique identifier." + }, + "name": { + "type": "string", + "description": "Gets or sets the friendly name of the job." + }, + "type": { + "type": "string", + "description": "Gets or sets the job type of the current job (i.e. Hive or U-SQL).", + "enum": [ + "USql", + "Hive" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": false + } + }, + "submitter": { + "type": "string", + "description": "Gets or sets the user or account that submitted the job." + }, + "errorMessage": { + "type": "string", + "description": "Gets or sets the error message details for the job, if it failed." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the degree of parallelism used for this job. This must have a minimum value of 2" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the priority value for the current job which must be greater than 1." + }, + "submitTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the time the job was submitted to the service." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time of the job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the completion time of the job" + }, + "state": { + "type": "string", + "description": "Gets or sets a more detailed state of the job than the result. Especially used for intermediate states and errors", + "enum": [ + "Accepted", + "Compiling", + "Ended", + "New", + "Queued", + "Running", + "Scheduling", + "Starting", + "Paused", + "WaitingForCapacity" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false + } + }, + "result": { + "type": "string", + "description": "Gets or sets the result of job execution or the current result of the running job.", + "enum": [ + "None", + "Succeeded", + "Cancelled", + "Failed" + ], + "x-ms-enum": { + "name": "JobResult", + "modelAsString": false + } + }, + "stateAuditRecords": { + "type": "array", + "items": { + "$ref": "#/definitions/JobStateAuditRecord" + }, + "description": "Gets or sets the job state audit records, indicating when various operations have been performed on this job." + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "Gets or sets the job specific properties." + } + }, + "required": [ + "jobId", + "name", + "type", + "properties" + ], + "description": "The common Data Lake Analytics job information properties." + }, + "JobInfoListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobInformation" + }, + "description": "Gets or sets the list of jobInfo items." + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link (url) to the next page of results." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the total count of results that are available, but might not be returned in the current page." + } + }, + "description": "List of jobInfo items." + }, + "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": "header", + "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." + }, + "jobServiceUriInPathParameter": { + "name": "jobserviceuri", + "in": "path", + "required": true, + "type": "string", + "default": "\"azuredatalakeanalytics.net\"", + "description": "Gets the URI used as the base for all cloud service requests." + } + } +} \ No newline at end of file diff --git a/arm-datalake-store/account/2015-10-01-preview/swagger/account.json b/arm-datalake-store/account/2015-10-01-preview/swagger/account.json new file mode 100644 index 000000000000..66564e695574 --- /dev/null +++ b/arm-datalake-store/account/2015-10-01-preview/swagger/account.json @@ -0,0 +1,848 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataLakeStoreManagementClient", + "description": "Creates a Data Lake Store account management client.", + "version": "2015-10-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{firewallRuleName}": { + "delete": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_DeleteFirewallRule", + "description": "Deletes the specified firewall rule from the specified Data Lake Store 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 account to delete the firewall rule from" + }, + { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule to delete" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + } + } + }, + "get": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_GetFirewallRule", + "description": "Gets the specified Data Lake firewall rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the account is in." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to get the firewall rules from" + }, + { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "the name of the firewall rule to retrieve." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules": { + "get": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_ListFirewallRules", + "description": "Lists the Data Lake firewall rules objects within the specified Data Lake Store 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 account to get the firewall rules from" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreFirewallRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{nextLink}": { + "get": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_FirewallRulesListNext", + "description": "Gets the next page of the Data Lake firewall rule objects within the specified account, if any.", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "The url to the next firewall rule page.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreFirewallRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}/firewallRules/{name}": { + "put": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_CreateOrUpdateFirewallRule", + "description": "Creates or updates the specified Data Lake Store account with the specified firewall rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the account is in." + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to add the firewall rule to" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The new of the firewall rule to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "Parameters supplied to the create firewall rule operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{name}": { + "put": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_Create", + "description": "Creates the specified Data Lake Store account.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the account will be associated with." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to create." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + }, + "description": "Parameters supplied to the create Data Lake Store account operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_Update", + "description": "Updates the Data Lake Store account object specified by the account name with the contents of the account object.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + }, + "description": "Parameters supplied to the update Data Lake Store account operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts/{accountName}": { + "delete": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_Delete", + "description": "Deletes the Data Lake Store account object specified by the account name.", + "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 account to delete" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "" + }, + "404": { + "description": "" + }, + "204": { + "description": "" + }, + "202": { + "description": "" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_Get", + "description": "Gets the Data Lake Store account object specified by the account name.", + "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 account to retrieve" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccount" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataLakeStore/accounts": { + "get": { + "tags": [ + "DataLakeStoreAccount" + ], + "operationId": "DataLakeStoreAccount_List", + "description": "Lists the Data Lake Store account objects within the subscription or within a specific resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData filter. Optional." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories/$expand=Products would expand Product data in line with each Category entry. Optional." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the OrderBy clause. One or more comma-separated expressions with an optional “asc” (the default) or “desc” depending on the order you’d like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional." + }, + { + "name": "$count", + "in": "query", + "required": false, + "type": "boolean", + "description": "Gets or sets a Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional." + }, + { + "name": "$search", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets a free form search. A free-text search expression to match for whether a particular entry should be included in the feed, e.g. Categories?$search=blue OR green. Optional." + }, + { + "name": "$format", + "in": "query", + "required": false, + "type": "string", + "description": "Gets or sets the return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/DataLakeStoreAccountListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DataLakeStoreAccount" + } + } + }, + "definitions": { + "FirewallRuleProperties": { + "properties": { + "startIpAddress": { + "type": "string", + "description": "Gets or sets the start IP address for the firewall rule." + }, + "endIpAddress": { + "type": "string", + "description": "Gets or sets the end IP address for the firewall rule." + } + }, + "description": "Data Lake firewall rule properties information" + }, + "FirewallRule": { + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the Firewall Rule's name." + }, + "type": { + "type": "string", + "description": "Gets or sets the namespace and type of the Firewall Rule." + }, + "id": { + "type": "string", + "description": "Gets or sets the Firewall Rule's subscription ID." + }, + "location": { + "type": "string", + "description": "Gets or sets the Firewall Rule's regional location." + }, + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "description": "Gets or sets the properties defined by Data Lake all properties are specific to each resource provider." + } + }, + "description": "Data Lake firewall rule information" + }, + "DataLakeStoreFirewallRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "Gets or set the results of the list operation" + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link (url) to the next page of results." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the total count of results that are available, but might not be returned in the current page." + } + }, + "description": "Data Lake firewall rule list information." + }, + "DataLakeStoreAccountProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the Data Lake Store account while being provisioned.", + "enum": [ + "Failed", + "Creating", + "Running", + "Succeeded", + "Patching", + "Suspending", + "Resuming", + "Deleting", + "Deleted" + ], + "x-ms-enum": { + "name": "DataLakeStoreAccountStatus", + "modelAsString": false + } + }, + "state": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the Data Lake Account after provisioning has completed.", + "enum": [ + "active", + "suspended" + ], + "x-ms-enum": { + "name": "DataLakeStoreAccountState", + "modelAsString": false + } + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the account creation time." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the account last modified time." + }, + "endpoint": { + "type": "string", + "description": "Gets or sets the gateway host." + }, + "defaultGroup": { + "type": "string", + "description": "Gets or sets the default owner group for all new folders and files created in the DataLake." + } + }, + "description": "Data Lake Store account properties information" + }, + "DataLakeStoreAccount": { + "properties": { + "location": { + "type": "string", + "description": "Gets or sets the account regional location." + }, + "name": { + "type": "string", + "description": "Gets or sets the account name." + }, + "type": { + "type": "string", + "description": "Gets or sets the namespace and type of the account." + }, + "id": { + "type": "string", + "description": "Gets or sets the account subscription ID." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the value of custom properties." + }, + "properties": { + "$ref": "#/definitions/DataLakeStoreAccountProperties", + "description": "Gets or sets the properties defined by Data Lake all properties are specific to each resource provider." + } + }, + "description": "Data Lake Store account information" + }, + "DataLakeStoreAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataLakeStoreAccount" + }, + "description": "Gets or set the results of the list operation" + }, + "nextLink": { + "type": "string", + "description": "Gets or sets the link (url) to the next page of results." + }, + "count": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the total count of results that are available, but might not be returned in the current page." + } + }, + "description": "Data Lake Store account list information response." + }, + "ErrorDetails": { + "properties": { + "code": { + "type": "string", + "description": "Gets or sets the HTTP status code or error code associated with this error" + }, + "message": { + "type": "string", + "description": "Gets or sets the error message localized based on Accept-Language" + }, + "target": { + "type": "string", + "description": "Gets or sets the target of the particular error (for example, the name of the property in error)." + } + }, + "description": "Data Lake error details information" + }, + "InnerError": { + "properties": { + "trace": { + "type": "string", + "description": "Gets or sets the stack trace for the error" + }, + "context": { + "type": "string", + "description": "Gets or sets the context for the error message" + } + }, + "description": "Data Lake inner error information" + }, + "Error": { + "properties": { + "code": { + "type": "string", + "description": "Gets or sets the HTTP status code or error code associated with this error" + }, + "message": { + "type": "string", + "description": "Gets or sets the error message to display." + }, + "target": { + "type": "string", + "description": "Gets or sets the target of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "description": "Gets or sets the list of error details" + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "description": "Gets or sets the inner exceptions or errors, if any" + } + }, + "required": [ + "code", + "message" + ], + "description": "Data Lake error information" + }, + "AzureAsyncOperationResult": { + "properties": { + "status": { + "type": "string", + "description": "Gets or sets the status of the AzureAsuncOperation", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": false + } + }, + "error": { + "$ref": "#/definitions/Error" + } + }, + "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." + }, + "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-datalake-store/filesystem/2015-10-01-preview/swagger/filesystem.json b/arm-datalake-store/filesystem/2015-10-01-preview/swagger/filesystem.json new file mode 100644 index 000000000000..dc2306513fea --- /dev/null +++ b/arm-datalake-store/filesystem/2015-10-01-preview/swagger/filesystem.json @@ -0,0 +1,2053 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataLakeStoreFileSystemManagementClient", + "description": "Creates a Data Lake Store filesystem management client.", + "version": "2015-10-01-preview" + }, + "host": "accountname.datalakeserviceuri", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/octet-stream" + ], + "paths": { + "/WebHdfsExt/{filePath}": { + "post": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_ConcurrentAppend", + "description": "Appends to the file specified. This method supports multiple concurrent appends to the file. NOTE: that concurrent append and serial append CANNOT be used interchangeably. Once a file has been appended to using either one, it can only be appended to using that type of append.", + "parameters": [ + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to append to using concurrent append." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the data lake account that the file lives in." + }, + { + "name": "streamContents", + "in": "body", + "schema": { + "type": "object", + "format": "file" + }, + "required": true, + "description": "The file contents to include when appending to the file." + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "CONCURRENTAPPEND" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{path}": { + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_CheckAccess", + "description": "Checks if the specified access is available at the given path.", + "parameters": [ + { + "name": "path", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file or folder to check access for." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "fsaction", + "in": "query", + "required": false, + "type": "string", + "description": "File system operation read/write/execute in string form, matching regex pattern '[rwx-]{3}'" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "CHECKACCESS" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_Mkdirs", + "description": "Creates a directory.", + "parameters": [ + { + "name": "path", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory to create." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "permission", + "in": "query", + "required": false, + "type": "string", + "description": "The optional permissions to set on the directories" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "MKDIRS" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FileOperationResult" + } + } + } + } + }, + "/webhdfs/v1/{destinationPath}": { + "post": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_Concat", + "description": "Concatenates the list of files into the target file.", + "parameters": [ + { + "name": "destinationPath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the destination file resulting from the concatenation." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "sources", + "in": "query", + "required": false, + "type": "string", + "description": "A list of comma seperated absolute FileSystem paths without scheme and authority" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "CONCAT" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{msConcatDestinationPath}": { + "post": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_MsConcat", + "description": "Concatenates the list of files into the target file. This API is NOT webhdfs compliant, however supports a much larger list of files in the concatenate list.", + "parameters": [ + { + "name": "msConcatDestinationPath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the destination file resulting from the concatenation." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "deletesourcedirectory", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates two things to the system which allow for optimizations and increased concatenate performance. First, that all the streams being concatenated are in the same source directory. Second, that the source directory ONLY has streams in it that are being concatenated into the destination stream. Note that only the first requirement is strictly enforced (concatenate will ignore the flag and only delete the source streams, not the folder). If the first option is met, ALL data that was not part of the set of streams being concatenated WILL BE LOST. It is critical to only use this option if you are certain the two requirements are met." + }, + { + "name": "streamContents", + "in": "body", + "required": true, + "schema": { + "type": "object", + "format": "file" + }, + "description": "A list of comma seperated absolute FileSystem paths without scheme and authority. In the format: 'sources='" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "MSCONCAT" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{listFilePath}": { + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_ListFileStatus", + "description": "Get the list of file status objects specified by the file path.", + "parameters": [ + { + "name": "listFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to retrieve status for." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to return. Optional." + }, + { + "name": "$skip", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of items to skip over before returning elements. Optional." + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "LISTSTATUS" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FileStatusesResult" + } + } + } + } + }, + "/webhdfs/va/{getContentSummaryFilePath}": { + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_GetContentSummary", + "description": "Gets the file content summary object specified by the file path.", + "parameters": [ + { + "name": "getContentSummaryFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to retrieve the summary for." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "GETCONTENTSUMMARY" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ContentSummaryResult" + } + } + } + } + }, + "/webhdfs/v1/{getFilePath}": { + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_GetFileStatus", + "description": "Get the file status object specified by the file path.", + "parameters": [ + { + "name": "getFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to retrieve status for." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "GETFILESTATUS" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FileStatusResult" + } + } + } + } + }, + "/webhdfs/v1/{directFilePath}": { + "post": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_DirectAppend", + "description": "Directly appends to a file with the specified content, without requiring a redirect. This API is NOT webhdfs compliant. It should be used only by tools that do not rely on webhdfs interoperability.", + "parameters": [ + { + "name": "directFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to append to." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to append to the file in" + }, + { + "name": "streamContents", + "in": "body", + "schema": { + "type": "object", + "format": "file" + }, + "required": true, + "description": "The file contents to include when appending to the file." + }, + { + "name": "buffersize", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The optional buffer size to use when appending data" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "APPEND" + }, + { + "name": "append", + "in": "query", + "required": false, + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "type": "boolean", + "default": "true" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_DirectCreate", + "description": "Directly creates a file with the specified content, without requiring a redirect. This API is NOT webhdfs compliant. It should be used only by tools that do not rely on webhdfs interoperability.", + "parameters": [ + { + "name": "directFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to create." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to create the file in" + }, + { + "name": "streamContents", + "in": "body", + "schema": { + "type": "object", + "format": "file" + }, + "required": false, + "description": "The file contents to include when creating the file. This parameter is optional, resulting in an empty file if not specified." + }, + { + "name": "buffersize", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The size of the buffer used in transferring data." + }, + { + "name": "overwrite", + "in": "query", + "required": false, + "type": "boolean", + "description": "The indication of if the file should be overwritten." + }, + { + "name": "blocksize", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The block size of a file, in bytes." + }, + { + "name": "replication", + "in": "query", + "required": false, + "type": "integer", + "format": "int16", + "description": "The number of replications of a file." + }, + { + "name": "permission", + "in": "query", + "required": false, + "type": "string", + "description": "The permissions of a file or directory." + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "CREATE" + }, + { + "name": "write", + "in": "query", + "required": false, + "type": "boolean", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "true" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "201": { + "description": "" + } + } + }, + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_DirectOpen", + "description": "Directly opens and reads from the specified file, without requiring a redirect. This API is NOT webhdfs compliant. It should be used only by tools that do not rely on webhdfs interoperability.", + "parameters": [ + { + "name": "directFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to open." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the data lake account that the file lives in." + }, + { + "name": "length", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "buffersize", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "OPEN" + }, + { + "name": "read", + "in": "query", + "required": false, + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "type": "boolean", + "default": "true" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": + { + "type": "string", + "format": "byte" + } + } + } + } + }, + "/webhdfs/v1/{setAclFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_SetAcl", + "description": "Sets ACL entries on a file or folder.", + "parameters": [ + { + "name": "setAclFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to set ACLs on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "aclspec", + "in": "query", + "required": true, + "type": "string", + "description": "The ACL spec included in ACL creation operations in the format '[default:]user|group|other::r|-w|-x|-'" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "SETACL" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{modifyAclFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_ModifyAclEntries", + "description": "Modifies existing ACL entries on a file or folder.", + "parameters": [ + { + "name": "modifyAclFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to modify ACLs on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "aclspec", + "in": "query", + "required": true, + "type": "string", + "description": "The ACL spec included in ACL modification operations in the format '[default:]user|group|other::r|-w|-x|-'" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "MODIFYACLENTRIES" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{removeAclFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_RemoveAclEntries", + "description": "Removes existing ACL entries on a file or folder.", + "parameters": [ + { + "name": "removeAclFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to remove ACLs on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "aclspec", + "in": "query", + "required": true, + "type": "string", + "description": "The ACL spec included in ACL removal operations in the format '[default:]user|group|other'" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "REMOVEACLENTRIES" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{removeDefaultAclFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_RemoveDefaultAcl", + "description": "Removes default ACL entries on a file or folder.", + "parameters": [ + { + "name": "removeDefaultAclFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to remove ACL on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "REMOVEDEFAULTACL" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{aclFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_RemoveAcl", + "description": "Removes the existing ACL on a file or folder.", + "parameters": [ + { + "name": "aclFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to remove ACL on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "REMOVEACL" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + }, + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_GetAclStatus", + "description": "Gets ACL entries on a file or folder.", + "parameters": [ + { + "name": "aclFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to get ACLs on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "GETACLSTATUS" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AclStatusResult" + } + } + } + } + }, + "/webhdfs/v1/{filePath}": { + "post": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_BeginAppend", + "description": "Initiates a file append request, resulting in a return of the data node location that will service the request.", + "parameters": [ + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to append to." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to append to the file in" + }, + { + "name": "buffersize", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The optional buffer size to use when appending data" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "APPEND" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "307": { + "description": "", + "headers": { + "location": { + "description": "The location of the file to be appended to", + "type": "string" + } + } + } + } + }, + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_BeginCreate", + "description": "Initiates a file creation request, resulting in a return of the data node location that will service the request.", + "parameters": [ + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to create." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Data Lake Store account to create the file in" + }, + { + "name": "buffersize", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The size of the buffer used in transferring data." + }, + { + "name": "overwrite", + "in": "query", + "required": false, + "type": "boolean", + "description": "The indication of if the file should be overwritten." + }, + { + "name": "blocksize", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The block size of a file, in bytes." + }, + { + "name": "replication", + "in": "query", + "required": false, + "type": "integer", + "format": "int16", + "description": "The number of replications of a file." + }, + { + "name": "permission", + "in": "query", + "required": false, + "type": "string", + "description": "The permissions of a file or directory." + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "CREATE" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "307": { + "description": "", + "headers": { + "location": { + "description": "The location of the file to be created", + "type": "string" + } + } + } + } + }, + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_BeginOpen", + "description": "Initiates a file open (read) request, resulting in a return of the data node location that will service the request.", + "parameters": [ + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file to open." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the data lake account that the file lives in." + }, + { + "name": "length", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "buffersize", + "in": "query", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "OPEN" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "307": { + "description": "", + "headers": { + "location": { + "description": "The location of the file to be opened", + "type": "string" + } + } + } + } + }, + "delete": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_Delete", + "description": "Deletes the requested file or folder, optionally recursively.", + "parameters": [ + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file or folder to delete." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "The optional switch indicating if the delete should be recursive" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "DELETE" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FileOperationResult" + } + } + } + } + }, + "/webhdfs/v1/{symLinkFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_CreateSymLink", + "description": "Creates a symbolic link.", + "parameters": [ + { + "name": "symLinkFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to create a symlink of." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "destination", + "in": "query", + "required": true, + "type": "string", + "description": "The path to create the symlink at" + }, + { + "name": "createParent", + "in": "query", + "required": false, + "type": "boolean", + "default": "false", + "description": "If the parent directories do not exist, indicates if they should be created." + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "CREATESYMLINK" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{renameFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_Rename", + "description": "Rename a directory or file.", + "parameters": [ + { + "name": "renameFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory to move/rename." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "destination", + "in": "query", + "required": true, + "type": "string", + "description": "The path to move/rename the file or folder to" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "RENAME" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FileOperationResult" + } + } + } + } + }, + "/webhdfs/v1/{setOwnerFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_SetOwner", + "description": "Sets the owner of a file or folder.", + "parameters": [ + { + "name": "setOwnerFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to set the owner on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "owner", + "in": "query", + "required": false, + "type": "string", + "description": "The username who is the owner of a file/directory, if empty remains unchanged." + }, + { + "name": "group", + "in": "query", + "required": false, + "type": "string", + "description": "The group who is the group owner of a file/directory, if empty remains unchanged." + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "SETOWNER" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{setPermissionFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_SetPermission", + "description": "Sets the permission of the file or folder.", + "parameters": [ + { + "name": "setPermissionFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to set permissions on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "permission", + "in": "query", + "required": false, + "type": "string", + "description": "A string octal representation of the permission (i.e 'rwx'), if empty remains unchanged." + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "SETPERMISSION" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{setReplicationFilePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_SetReplication", + "description": "Sets the value of the replication factor.", + "parameters": [ + { + "name": "setReplicationFilePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to create a replication of." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "replication", + "in": "query", + "required": false, + "type": "integer", + "description": "The number of replications of a file." + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "SETREPLICATION" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/FileOperationResult" + } + } + } + } + }, + "/{fileAppendRequestLink}": { + "post": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_Append", + "description": "Appends to the file specified in the link that was returned from BeginAppend.", + "parameters": [ + { + "name": "fileAppendRequestLink", + "in": "path", + "required": true, + "type": "string", + "description": "The link to the file to append to including all required parameters.", + "x-ms-skip-url-encoding": true + }, + { + "name": "streamContents", + "in": "body", + "schema": { + "type": "object", + "format": "file" + }, + "required": true, + "description": "The file contents to include when appending to the file." + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/{sourcePath}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_SetTimes", + "description": "Sets the access or modification time on a file or folder.", + "parameters": [ + { + "name": "sourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the directory or file to set permissions on." + }, + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "modificationtime", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The modification time of a file/directory. If -1 remains unchanged" + }, + { + "name": "accesstime", + "in": "query", + "required": false, + "type": "integer", + "format": "int64", + "description": "The access time of a file/directory. If -1 remains unchanged" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "SETTIMES" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/webhdfs/v1/": { + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_GetHomeDirectory", + "description": "Get the home directory for the specified account.", + "parameters": [ + { + "name": "accountname", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the account to use" + }, + { + "name": "op", + "in": "query", + "required": false, + "type": "string", + "description": "This is the REQUIRED value for this parameter and method combination. Changing the value will result in unexpected behavior, please do not do so.", + "default": "GETHOMEDIRECTORY" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + + { + "$ref": "#/parameters/dataLakeServiceUriInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/HomeDirectoryResult" + } + } + } + } + }, + "/{fileCreateRequestLink}": { + "put": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_Create", + "description": "Creates the file specified in the link that was returned from BeginCreate.", + "parameters": [ + { + "name": "fileCreateRequestLink", + "in": "path", + "required": true, + "type": "string", + "description": "The link to the file to create including all required parameters.", + "x-ms-skip-url-encoding": true + }, + { + "name": "streamContents", + "in": "body", + "schema": { + "type": "object", + "format": "file" + }, + "required": false, + "description": "The file contents to include when creating the file. This parameter is not required, and if not passed results an empty file." + } + ], + "responses": { + "201": { + "description": "" + } + } + } + }, + "/{fileOpenRequestLink}": { + "get": { + "tags": [ + "FileSystem" + ], + "operationId": "FileSystem_Open", + "description": "Gets the data associated with the file handle requested.", + "parameters": [ + { + "name": "fileOpenRequestLink", + "in": "path", + "required": true, + "type": "string", + "description": "The link to the file to open including all required parameters.", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "", + "schema": + { + "type": "string", + "format": "byte" + } + } + } + } + } + }, + "definitions": { + "FileOperationResult": { + "properties": { + "boolean": { + "type": "boolean", + "description": "Gets or sets the result of the operation or request" + } + }, + "description": "The result of the request or operation." + }, + "AclStatus": { + "properties": { + "entries": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Gets or sets the list of ACLSpec entries on a file or folder." + }, + "group": { + "type": "string", + "description": "Gets or sets the group owner." + }, + "owner": { + "type": "string", + "description": "Gets or sets the user who is the owner." + }, + "stickyBit": { + "type": "boolean", + "description": "Gets or sets the indicator of whether the sticky bit is on or off." + } + }, + "description": "Data Lake ACL status information" + }, + "AclStatusResult": { + "properties": { + "AclStatus": { + "$ref": "#/definitions/AclStatus", + "description": "Gets or sets the AclStatus object for a given folder or file" + } + }, + "description": "Data Lake Store filesystem Acl information." + }, + "HomeDirectoryResult": { + "properties": { + "Path": { + "type": "string", + "description": "Gets or sets the file path to the home directory" + } + }, + "description": "Data Lake Store filesystem home path response." + }, + "ContentSummary": { + "properties": { + "directoryCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the number of directories." + }, + "fileCount": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the number of files." + }, + "length": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the number of bytes used by the contet." + }, + "quota": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the namespace quota of this directory." + }, + "spaceConsumed": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the disk space consumed by the content." + }, + "spaceQuota": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the disk space quota." + } + }, + "description": "Data Lake content summary information" + }, + "ContentSummaryResult": { + "properties": { + "ContentSummary": { + "$ref": "#/definitions/ContentSummary", + "description": "Gets or sets the content summary for the specified path" + } + }, + "description": "Data Lake Store filesystem content summary information response." + }, + "FileStatusProperties": { + "properties": { + "accessTime": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the last access time." + }, + "blockSize": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the block size for the file." + }, + "childrenNum": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the number of children in the directory." + }, + "fileId": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the file identifier." + }, + "group": { + "type": "string", + "description": "Gets or sets the group owner." + }, + "length": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the number of bytes in a file." + }, + "modificationTime": { + "type": "integer", + "format": "int64", + "description": "Gets or sets the modification time." + }, + "owner": { + "type": "string", + "description": "Gets or sets the user who is the owner." + }, + "pathSuffix": { + "type": "string", + "description": "Gets or sets the path suffix." + }, + "permission": { + "type": "string", + "description": "Gets or sets the permission represented as an octal string." + }, + "replication": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of replications of a file." + }, + "type": { + "type": "string", + "description": "Gets or sets the type of the path object.", + "enum": [ + "File", + "Directory" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": false + } + } + }, + "description": "Data Lake file status properties information" + }, + "FileStatuses": { + "properties": { + "FileStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/FileStatusProperties" + }, + "description": "Gets or sets the object containing the list of properties of the files." + } + }, + "description": "Data Lake file status list information" + }, + "FileStatusesResult": { + "properties": { + "FileStatuses": { + "$ref": "#/definitions/FileStatuses", + "description": "Gets or sets the object representing the list of file statuses" + } + }, + "description": "Data Lake Store filesystem file status list information response." + }, + "FileStatusResult": { + "properties": { + "FileStatus": { + "$ref": "#/definitions/FileStatusProperties", + "description": "Gets or sets the file status object associated with the specified file path" + } + }, + "description": "Data Lake Store filesystem file status information response." + }, + "FileCreateOpenAndAppendResult": { + "properties": { + "Location": { + "type": "string", + "description": "Gets or sets the redirect URI location with any necessary parameters" + } + }, + "description": "The response recieved after the BeginOpen, BeginCreate and BeginAppend requests." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "header", + "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." + }, + "dataLakeServiceUriInPath": { + "name": "datalakeserviceuri", + "in": "path", + "required": true, + "type": "string", + "default": "\"azuredatalakestore.net\"", + "description": "Gets the URI used as the base for all cloud service requests." + } + } +} \ No newline at end of file diff --git a/arm-dns/2015-05-04-preview/swagger/dns.json b/arm-dns/2015-05-04-preview/swagger/dns.json index 9f2703a69dba..4e0738634357 100644 --- a/arm-dns/2015-05-04-preview/swagger/dns.json +++ b/arm-dns/2015-05-04-preview/swagger/dns.json @@ -57,7 +57,9 @@ "SRV", "TXT" ], - "x-ms-enum": "RecordType" + "x-ms-enum": { + "name": "RecordType" + } }, { "name": "relativeRecordSetName", @@ -145,7 +147,9 @@ "SRV", "TXT" ], - "x-ms-enum": "RecordType" + "x-ms-enum": { + "name": "RecordType" + } }, { "name": "relativeRecordSetName", @@ -212,7 +216,9 @@ "SRV", "TXT" ], - "x-ms-enum": "RecordType" + "x-ms-enum": { + "name": "RecordType" + } }, { "name": "relativeRecordSetName", @@ -278,7 +284,9 @@ "SRV", "TXT" ], - "x-ms-enum": "RecordType" + "x-ms-enum": { + "name": "RecordType" + } }, { "name": "$top", @@ -309,7 +317,9 @@ } } }, - "x-ms-pageable": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-odata": "#/definitions/RecordSet" } }, @@ -364,7 +374,9 @@ } } }, - "x-ms-pageable": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-odata": "#/definitions/RecordSet" } }, @@ -552,7 +564,9 @@ } } }, - "x-ms-pageable": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-odata": "#/definitions/Zone" } }, @@ -593,7 +607,9 @@ } } }, - "x-ms-pageable": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-odata": "#/definitions/Zone" } } diff --git a/arm-graphrbac/1.42-previewInternal/swagger/graphrbac.json b/arm-graphrbac/1.42-previewInternal/swagger/graphrbac.json index 0bc8edbe1cd4..feed6c3227a4 100644 --- a/arm-graphrbac/1.42-previewInternal/swagger/graphrbac.json +++ b/arm-graphrbac/1.42-previewInternal/swagger/graphrbac.json @@ -209,7 +209,8 @@ } }, "x-ms-pageable": { - "nextLinkName": "odata.nextLink" + "nextLinkName": "odata.nextLink", + "operationName": "Objects_GetObjectsByObjectIdsNext" } } }, @@ -410,7 +411,8 @@ } }, "x-ms-pageable": { - "nextLinkName": "odata.nextLink" + "nextLinkName": "odata.nextLink", + "operationName": "Group_ListNext" }, "x-ms-odata": "#/definitions/ADGroup" } @@ -450,7 +452,8 @@ } }, "x-ms-pageable": { - "nextLinkName": "odata.nextLink" + "nextLinkName": "odata.nextLink", + "operationName": "Group_GetGroupMembersNext" } } }, @@ -607,7 +610,8 @@ } }, "x-ms-pageable": { - "nextLinkName": "odata.nextLink" + "nextLinkName": "odata.nextLink", + "operationName": "ServicePrincipal_ListNext" }, "x-ms-odata": "#/definitions/ServicePrincipal" } @@ -787,7 +791,8 @@ } }, "x-ms-pageable": { - "nextLinkName": "odata.nextLink" + "nextLinkName": "odata.nextLink", + "operationName": "User_ListNext" }, "x-ms-odata": "#/definitions/User" } @@ -880,6 +885,208 @@ } } }, + "x-ms-paths": { + "/{tenantID}/{nextLink}?Objects_GetObjectsByObjectIdsNext": { + "post": { + "tags": [ + "Objects" + ], + "operationId": "Objects_GetObjectsByObjectIdsNext", + "description": "Gets AD group membership by provided AD object Ids", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "Next link for list operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/tenantIDInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GetObjectsResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink", + "operationName": "Objects_GetObjectsByObjectIdsNext" + } + } + }, + "/{tenantID}/{nextLink}?Group_ListNext": { + "get": { + "tags": [ + "Group" + ], + "operationId": "Group_ListNext", + "description": "Gets list of groups for the current tenant.", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "Next link for list operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/tenantIDInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink", + "operationName": "Group_ListNext" + } + } + }, + "/{tenantID}/{nextLink}?Group_GetGroupMembersNext": { + "get": { + "tags": [ + "Group" + ], + "operationId": "Group_GetGroupMembersNext", + "description": "Gets the members of a group.", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "Next link for list operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/tenantIDInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GetObjectsResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink", + "operationName": "Group_GetGroupMembersNext" + } + } + }, + "/{tenantID}/{nextLink}?ServicePrincipal_ListNext": { + "get": { + "tags": [ + "ServicePrincipal" + ], + "operationId": "ServicePrincipal_ListNext", + "description": "Gets list of service principals from the current tenant.", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "Next link for list operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/tenantIDInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServicePrincipalListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink", + "operationName": "ServicePrincipal_ListNext" + } + } + }, + "/{tenantID}/{nextLink}?User_ListNext": { + "get": { + "tags": [ + "User" + ], + "operationId": "User_ListNext", + "description": "Gets list of users for the current tenant.", + "parameters": [ + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "Next link for list operation.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/tenantIDInPath" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/UserListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink", + "operationName": "User_ListNext" + } + } + } + }, "definitions": { "KeyCredential": { "properties": { diff --git a/arm-logic/2015-02-01-preview/swagger/logic.json b/arm-logic/2015-02-01-preview/swagger/logic.json index 75dabfffd7b0..107e5b801d34 100644 --- a/arm-logic/2015-02-01-preview/swagger/logic.json +++ b/arm-logic/2015-02-01-preview/swagger/logic.json @@ -1999,7 +1999,7 @@ "Standard", "Premium" ], - "x-ms-enum": { "name": "SkuName", "modelAsString": "False" } + "x-ms-enum": { "name": "SkuName", "modelAsString": false } }, "WorkflowState": { "type": "string", @@ -2010,7 +2010,7 @@ "Deleted", "Suspended" ], - "x-ms-enum": { "name": "WorkflowState", "modelAsString": "False" } + "x-ms-enum": { "name": "WorkflowState", "modelAsString": false } }, "WorkflowStatus": { "type": "string", @@ -2025,7 +2025,7 @@ "Cancelled", "Failed" ], - "x-ms-enum": { "name": "WorkflowStatus", "modelAsString": "False" } + "x-ms-enum": { "name": "WorkflowStatus", "modelAsString": false } }, "ParameterType": { "type": "string", @@ -2040,7 +2040,7 @@ "Object", "SecureObject" ], - "x-ms-enum": { "name": "ParameterType", "modelAsString": "False" } + "x-ms-enum": { "name": "ParameterType", "modelAsString": false } }, "KeyType": { "type": "string", @@ -2049,7 +2049,7 @@ "Primary", "Secondary" ], - "x-ms-enum": { "name": "KeyType", "modelAsString": "False" } + "x-ms-enum": { "name": "KeyType", "modelAsString": false } }, "Sku": { "type": "object", @@ -2183,7 +2183,7 @@ "Month", "Year" ], - "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": "False" } + "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": false } }, "WorkflowTriggerRecurrence": { "type": "object", @@ -2278,7 +2278,7 @@ "Succeeded", "Updating" ], - "x-ms-enum": { "name": "WorkflowTriggerProvisioningState", "modelAsString": "False" } + "x-ms-enum": { "name": "WorkflowTriggerProvisioningState", "modelAsString": false } }, "WorkflowProvisioningState": { "type": "string", @@ -2287,7 +2287,7 @@ "Moving", "Succeeded" ], - "x-ms-enum": { "name": "WorkflowProvisioningState", "modelAsString": "False" } + "x-ms-enum": { "name": "WorkflowProvisioningState", "modelAsString": false } } }, "parameters": { diff --git a/arm-network/2015-05-01-preview/swagger/network.json b/arm-network/2015-05-01-preview/swagger/network.json index e02899863dcc..853fd5dde3cd 100644 --- a/arm-network/2015-05-01-preview/swagger/network.json +++ b/arm-network/2015-05-01-preview/swagger/network.json @@ -2947,7 +2947,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -3733,7 +3733,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewaySkuName", - "modelAsString": "True" + "modelAsString": true } }, "tier": { @@ -3744,7 +3744,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayTier", - "modelAsString": "True" + "modelAsString": true } }, "capacity": { @@ -3846,7 +3846,7 @@ ], "x-ms-enum": { "name": "IpAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "subnet": { @@ -3993,7 +3993,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayProtocol", - "modelAsString": "True" + "modelAsString": true } }, "cookieBasedAffinity": { @@ -4005,7 +4005,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayCookieBasedAffinity", - "modelAsString": "True" + "modelAsString": true } }, "provisioningState": { @@ -4055,7 +4055,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayProtocol", - "modelAsString": "True" + "modelAsString": true } }, "sslCertificate": { @@ -4100,7 +4100,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayRequestRoutingRuleType", - "modelAsString": "True" + "modelAsString": true } }, "backendAddressPool": { @@ -4161,7 +4161,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayOperationalState", - "modelAsString": "True" + "modelAsString": true } }, "gatewayIPConfigurations": { @@ -4279,7 +4279,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitSkuTier", - "modelAsString": "True" + "modelAsString": true } }, "family": { @@ -4291,7 +4291,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitSkuFamily", - "modelAsString": "True" + "modelAsString": true } } }, @@ -4312,7 +4312,7 @@ ], "x-ms-enum": { "name": "AuthorizationUseStatus", - "modelAsString": "True" + "modelAsString": true } }, "provisioningState": { @@ -4362,7 +4362,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitPeeringAdvertisedPublicPrefixState", - "modelAsString": "True" + "modelAsString": true } }, "customerASN": { @@ -4404,7 +4404,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitPeeringType", - "modelAsString": "True" + "modelAsString": true } }, "state": { @@ -4416,7 +4416,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitPeeringState", - "modelAsString": "True" + "modelAsString": true } }, "azureASN": { @@ -4524,7 +4524,7 @@ ], "x-ms-enum": { "name": "ServiceProviderProvisioningState", - "modelAsString": "True" + "modelAsString": true } }, "authorizations": { @@ -4628,7 +4628,7 @@ ], "x-ms-enum": { "name": "RouteNextHopType", - "modelAsString": "True" + "modelAsString": true } }, "nextHopIP": { @@ -4797,7 +4797,7 @@ ], "x-ms-enum": { "name": "IpAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "subnet": { @@ -4935,7 +4935,7 @@ ], "x-ms-enum": { "name": "TransportProtocol", - "modelAsString": "True" + "modelAsString": true } }, "loadDistribution": { @@ -4948,7 +4948,7 @@ ], "x-ms-enum": { "name": "LoadDistribution", - "modelAsString": "True" + "modelAsString": true } }, "frontendPort": { @@ -5022,7 +5022,7 @@ ], "x-ms-enum": { "name": "ProbeProtocol", - "modelAsString": "True" + "modelAsString": true } }, "port": { @@ -5094,7 +5094,7 @@ ], "x-ms-enum": { "name": "TransportProtocol", - "modelAsString": "True" + "modelAsString": true } }, "frontendPort": { @@ -5164,7 +5164,7 @@ ], "x-ms-enum": { "name": "TransportProtocol", - "modelAsString": "True" + "modelAsString": true } }, "frontendPortRangeStart": { @@ -5442,7 +5442,7 @@ ], "x-ms-enum": { "name": "IpAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "subnet": { @@ -5617,7 +5617,7 @@ ], "x-ms-enum": { "name": "RouteNextHopType", - "modelAsString": "True" + "modelAsString": true } }, "nextHopIpAddress": { @@ -5727,35 +5727,35 @@ ], "x-ms-enum": { "name": "SecurityRuleProtocol", - "modelAsString": "True" + "modelAsString": true } }, "sourcePortRange": { "type": "string", - "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix “*” can also be used to match all ports." + "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." }, "destinationPortRange": { "type": "string", - "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix “*” can also be used to match all ports." + "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." }, "sourceAddressPrefix": { "type": "string", - "description": "Gets or sets source address prefix. CIDR or source IP range. Asterix “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. " + "description": "Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " }, "destinationAddressPrefix": { "type": "string", - "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterix “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. " + "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. " }, "access": { "type": "string", - "description": "Gets or sets network traffic is allowed or denied. Possible values are “Allow” and “Deny”", + "description": "Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "SecurityRuleAccess", - "modelAsString": "True" + "modelAsString": true } }, "priority": { @@ -5772,7 +5772,7 @@ ], "x-ms-enum": { "name": "SecurityRuleDirection", - "modelAsString": "True" + "modelAsString": true } }, "provisioningState": { @@ -5911,7 +5911,7 @@ ], "x-ms-enum": { "name": "IpAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "ipConfiguration": { @@ -6116,7 +6116,7 @@ ], "x-ms-enum": { "name": "UsageUnit", - "modelAsString": "True" + "modelAsString": true } }, "currentValue": { @@ -6169,7 +6169,7 @@ ], "x-ms-enum": { "name": "IpAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "subnet": { @@ -6226,7 +6226,7 @@ ], "x-ms-enum": { "name": "VirtualNetworkGatewayType", - "modelAsString": "True" + "modelAsString": true } }, "vpnType": { @@ -6238,7 +6238,7 @@ ], "x-ms-enum": { "name": "VpnType", - "modelAsString": "True" + "modelAsString": true } }, "enableBgp": { @@ -6299,7 +6299,7 @@ ], "x-ms-enum": { "name": "VirtualNetworkGatewayConnectionType", - "modelAsString": "True" + "modelAsString": true } }, "routingWeight": { @@ -6322,7 +6322,7 @@ ], "x-ms-enum": { "name": "VirtualNetworkGatewayConnectionStatus", - "modelAsString": "True" + "modelAsString": true } }, "egressBytesTransferred": { @@ -6545,7 +6545,7 @@ ], "x-ms-enum": { "name": "NetworkOperationStatus", - "modelAsString": "True" + "modelAsString": true } }, "error": { diff --git a/arm-network/2015-06-15/swagger/network.json b/arm-network/2015-06-15/swagger/network.json index e539c7e10a59..c04d3b55cfab 100644 --- a/arm-network/2015-06-15/swagger/network.json +++ b/arm-network/2015-06-15/swagger/network.json @@ -2999,7 +2999,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -3842,7 +3842,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewaySkuName", - "modelAsString": "True" + "modelAsString": true } }, "tier": { @@ -3853,7 +3853,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayTier", - "modelAsString": "True" + "modelAsString": true } }, "capacity": { @@ -3955,7 +3955,7 @@ ], "x-ms-enum": { "name": "IPAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "subnet": { @@ -4102,7 +4102,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayProtocol", - "modelAsString": "True" + "modelAsString": true } }, "cookieBasedAffinity": { @@ -4114,7 +4114,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayCookieBasedAffinity", - "modelAsString": "True" + "modelAsString": true } }, "requestTimeout": { @@ -4173,7 +4173,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayProtocol", - "modelAsString": "True" + "modelAsString": true } }, "hostName": { @@ -4272,7 +4272,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayProtocol", - "modelAsString": "True" + "modelAsString": true } }, "host": { @@ -4337,7 +4337,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayRequestRoutingRuleType", - "modelAsString": "True" + "modelAsString": true } }, "backendAddressPool": { @@ -4402,7 +4402,7 @@ ], "x-ms-enum": { "name": "ApplicationGatewayOperationalState", - "modelAsString": "True" + "modelAsString": true } }, "gatewayIPConfigurations": { @@ -4579,7 +4579,7 @@ ], "x-ms-enum": { "name": "AuthorizationUseStatus", - "modelAsString": "True" + "modelAsString": true } }, "provisioningState": { @@ -4645,7 +4645,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitPeeringAdvertisedPublicPrefixState", - "modelAsString": "True" + "modelAsString": true } }, "customerASN": { @@ -4687,7 +4687,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitPeeringType", - "modelAsString": "True" + "modelAsString": true } }, "state": { @@ -4699,7 +4699,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitPeeringState", - "modelAsString": "True" + "modelAsString": true } }, "azureASN": { @@ -4803,7 +4803,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitSkuTier", - "modelAsString": "True" + "modelAsString": true } }, "family": { @@ -4815,7 +4815,7 @@ ], "x-ms-enum": { "name": "ExpressRouteCircuitSkuFamily", - "modelAsString": "True" + "modelAsString": true } } }, @@ -4856,7 +4856,7 @@ ], "x-ms-enum": { "name": "ServiceProviderProvisioningState", - "modelAsString": "True" + "modelAsString": true } }, "authorizations": { @@ -4960,7 +4960,7 @@ ], "x-ms-enum": { "name": "RouteNextHopType", - "modelAsString": "True" + "modelAsString": true } }, "nextHopIP": { @@ -5141,7 +5141,7 @@ ], "x-ms-enum": { "name": "IPAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "subnet": { @@ -5251,7 +5251,7 @@ ], "x-ms-enum": { "name": "TransportProtocol", - "modelAsString": "True" + "modelAsString": true } }, "loadDistribution": { @@ -5264,7 +5264,7 @@ ], "x-ms-enum": { "name": "LoadDistribution", - "modelAsString": "True" + "modelAsString": true } }, "frontendPort": { @@ -5338,7 +5338,7 @@ ], "x-ms-enum": { "name": "ProbeProtocol", - "modelAsString": "True" + "modelAsString": true } }, "port": { @@ -5410,7 +5410,7 @@ ], "x-ms-enum": { "name": "TransportProtocol", - "modelAsString": "True" + "modelAsString": true } }, "frontendPort": { @@ -5437,11 +5437,6 @@ "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" } }, - "required": [ - "protocol", - "frontendPort", - "enableFloatingIP" - ], "description": "Properties of Inbound NAT rule" }, "InboundNatRule": { @@ -5480,7 +5475,7 @@ ], "x-ms-enum": { "name": "TransportProtocol", - "modelAsString": "True" + "modelAsString": true } }, "frontendPortRangeStart": { @@ -5534,7 +5529,7 @@ }, "OutboundNatRulePropertiesFormat": { "properties": { - "allocatedOutboundPort": { + "allocatedOutboundPorts": { "type": "integer", "format": "int32", "description": "Gets or sets the number of outbound ports to be used for SNAT" @@ -5556,7 +5551,6 @@ } }, "required": [ - "allocatedOutboundPorts", "backendAddressPool" ], "description": "Outbound NAT pool of the loadbalancer" @@ -5918,35 +5912,35 @@ ], "x-ms-enum": { "name": "SecurityRuleProtocol", - "modelAsString": "True" + "modelAsString": true } }, "sourcePortRange": { "type": "string", - "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix “*” can also be used to match all ports." + "description": "Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." }, "destinationPortRange": { "type": "string", - "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix “*” can also be used to match all ports." + "description": "Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." }, "sourceAddressPrefix": { "type": "string", - "description": "Gets or sets source address prefix. CIDR or source IP range. Asterix “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. " + "description": "Gets or sets source address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " }, "destinationAddressPrefix": { "type": "string", - "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterix “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. " + "description": "Gets or sets destination address prefix. CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. " }, "access": { "type": "string", - "description": "Gets or sets network traffic is allowed or denied. Possible values are “Allow” and “Deny”", + "description": "Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "SecurityRuleAccess", - "modelAsString": "True" + "modelAsString": true } }, "priority": { @@ -5963,7 +5957,7 @@ ], "x-ms-enum": { "name": "SecurityRuleDirection", - "modelAsString": "True" + "modelAsString": true } }, "provisioningState": { @@ -6102,7 +6096,7 @@ ], "x-ms-enum": { "name": "IPAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "ipConfiguration": { @@ -6129,9 +6123,6 @@ "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" } }, - "required": [ - "publicIPAllocationMethod" - ], "description": "PublicIpAddress properties" }, "PublicIPAddress": { @@ -6185,7 +6176,7 @@ ], "x-ms-enum": { "name": "RouteNextHopType", - "modelAsString": "True" + "modelAsString": true } }, "nextHopIpAddress": { @@ -6326,7 +6317,7 @@ ], "x-ms-enum": { "name": "IPAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "subnet": { @@ -6390,10 +6381,7 @@ "type": "string", "description": "Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed" } - }, - "required": [ - "addressPrefix" - ] + } }, "Subnet": { "properties": { @@ -6455,7 +6443,7 @@ ], "x-ms-enum": { "name": "UsageUnit", - "modelAsString": "True" + "modelAsString": true } }, "currentValue": { @@ -6508,7 +6496,7 @@ ], "x-ms-enum": { "name": "IPAllocationMethod", - "modelAsString": "True" + "modelAsString": true } }, "subnet": { @@ -6565,7 +6553,7 @@ ], "x-ms-enum": { "name": "VirtualNetworkGatewayType", - "modelAsString": "True" + "modelAsString": true } }, "vpnType": { @@ -6577,7 +6565,7 @@ ], "x-ms-enum": { "name": "VpnType", - "modelAsString": "True" + "modelAsString": true } }, "enableBgp": { @@ -6659,7 +6647,7 @@ ], "x-ms-enum": { "name": "VirtualNetworkGatewaySkuName", - "modelAsString": "True" + "modelAsString": true } }, "tier": { @@ -6672,7 +6660,7 @@ ], "x-ms-enum": { "name": "VirtualNetworkGatewaySkuTier", - "modelAsString": "True" + "modelAsString": true } }, "capacity": { @@ -6694,7 +6682,7 @@ ], "x-ms-enum": { "name": "ProcessorArchitecture", - "modelAsString": "True" + "modelAsString": true } } }, @@ -6726,7 +6714,7 @@ ], "x-ms-enum": { "name": "VirtualNetworkGatewayConnectionType", - "modelAsString": "True" + "modelAsString": true } }, "routingWeight": { @@ -6749,7 +6737,7 @@ ], "x-ms-enum": { "name": "VirtualNetworkGatewayConnectionStatus", - "modelAsString": "True" + "modelAsString": true } }, "egressBytesTransferred": { @@ -7049,7 +7037,7 @@ ], "x-ms-enum": { "name": "NetworkOperationStatus", - "modelAsString": "True" + "modelAsString": true } }, "error": { diff --git a/arm-notificationhubs/2014-09-01/swagger/notificationhubs.json b/arm-notificationhubs/2014-09-01/swagger/notificationhubs.json index ee76ade43e2d..b1392a7ef956 100644 --- a/arm-notificationhubs/2014-09-01/swagger/notificationhubs.json +++ b/arm-notificationhubs/2014-09-01/swagger/notificationhubs.json @@ -1211,7 +1211,7 @@ ], "x-ms-enum": { "name": "NamespaceType", - "modelAsString": "False" + "modelAsString": false } } }, @@ -1306,7 +1306,7 @@ ], "x-ms-enum": { "name": "AccessRights", - "modelAsString": "False" + "modelAsString": false } }, "description": "The rights associated with the rule." diff --git a/arm-redis/2015-08-01/swagger/redis.json b/arm-redis/2015-08-01/swagger/redis.json index b33dd31fd043..536eb1ea303a 100644 --- a/arm-redis/2015-08-01/swagger/redis.json +++ b/arm-redis/2015-08-01/swagger/redis.json @@ -313,7 +313,7 @@ ], "x-ms-enum": { "name": "SkuName", - "modelAsString": "True" + "modelAsString": true } }, "family": { @@ -325,7 +325,7 @@ ], "x-ms-enum": { "name": "SkuFamily", - "modelAsString": "True" + "modelAsString": true } }, "capacity": { @@ -632,7 +632,7 @@ ], "x-ms-enum": { "name": "RedisKeyType", - "modelAsString": "False" + "modelAsString": false } } }, diff --git a/arm-resources/authorization/2015-01-01/swagger/authorization.json b/arm-resources/authorization/2015-01-01/swagger/authorization.json index 582cb451dc8a..cc09da1af102 100644 --- a/arm-resources/authorization/2015-01-01/swagger/authorization.json +++ b/arm-resources/authorization/2015-01-01/swagger/authorization.json @@ -623,7 +623,7 @@ ], "x-ms-enum": { "name": "LockLevel", - "modelAsString": "True" + "modelAsString": true } }, "notes": { diff --git a/arm-resources/resources/2014-04-01-preview/swagger/resources.json b/arm-resources/resources/2014-04-01-preview/swagger/resources.json index 13e72073426b..e91c72b94f43 100644 --- a/arm-resources/resources/2014-04-01-preview/swagger/resources.json +++ b/arm-resources/resources/2014-04-01-preview/swagger/resources.json @@ -1423,7 +1423,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -1592,7 +1592,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, @@ -2127,7 +2127,7 @@ ], "x-ms-enum": { "name": "DeploymentMode", - "modelAsString": "False" + "modelAsString": false } } }, @@ -2170,20 +2170,13 @@ "$ref": "#/definitions/ResourceManagementError" }, "description": "Gets or sets validation error." - }, - "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." } }, + "allOf": [ + { + "$ref": "#/definitions/ResourceManagementError" + } + ], "required": [ "code", "message" @@ -2342,7 +2335,7 @@ ], "x-ms-enum": { "name": "DeploymentMode", - "modelAsString": "False" + "modelAsString": false } } }, diff --git a/arm-resources/subscriptions/2014-04-01-preview/swagger/subscriptions.json b/arm-resources/subscriptions/2014-04-01-preview/swagger/subscriptions.json index eca329df21c3..d255e21aa383 100644 --- a/arm-resources/subscriptions/2014-04-01-preview/swagger/subscriptions.json +++ b/arm-resources/subscriptions/2014-04-01-preview/swagger/subscriptions.json @@ -45,7 +45,7 @@ } }, "x-ms-pageable": { - "nextLinkName": null + "nextLinkName": "nextLink" } } }, diff --git a/arm-scheduler/2014-08-01-preview/swagger/scheduler.json b/arm-scheduler/2014-08-01-preview/swagger/scheduler.json index c8dee7d7cd05..7007d00649d5 100644 --- a/arm-scheduler/2014-08-01-preview/swagger/scheduler.json +++ b/arm-scheduler/2014-08-01-preview/swagger/scheduler.json @@ -788,7 +788,7 @@ "Suspended", "Deleted" ], - "x-ms-enum": { "name": "JobCollectionState", "modelAsString": "False" } + "x-ms-enum": { "name": "JobCollectionState", "modelAsString": false } }, "quota": { "$ref": "#/definitions/JobCollectionQuota", @@ -806,7 +806,7 @@ "Free", "Premium" ], - "x-ms-enum": { "name": "SkuDefinition", "modelAsString": "False" } + "x-ms-enum": { "name": "SkuDefinition", "modelAsString": false } } } }, @@ -927,7 +927,7 @@ "MainAction", "ErrorAction" ], - "x-ms-enum": { "name": "JobHistoryActionName", "modelAsString": "False" } + "x-ms-enum": { "name": "JobHistoryActionName", "modelAsString": false } }, "status": { "$ref": "#/definitions/JobExecutionStatus", @@ -963,7 +963,7 @@ "ServiceBusQueue", "ServiceBusTopic" ], - "x-ms-enum": { "name": "JobActionType", "modelAsString": "False" } + "x-ms-enum": { "name": "JobActionType", "modelAsString": false } }, "request": { "$ref": "#/definitions/HttpRequest", @@ -1003,7 +1003,7 @@ "ServiceBusQueue", "ServiceBusTopic" ], - "x-ms-enum": { "name": "JobActionType", "modelAsString": "False" } + "x-ms-enum": { "name": "JobActionType", "modelAsString": false } }, "request": { "$ref": "#/definitions/HttpRequest", @@ -1137,7 +1137,7 @@ "ActiveDirectoryOAuth", "Basic" ], - "x-ms-enum": { "name": "HttpAuthenticationType", "modelAsString": "False" } + "x-ms-enum": { "name": "HttpAuthenticationType", "modelAsString": false } } } }, @@ -1220,7 +1220,7 @@ "NetMessaging", "AMQP" ], - "x-ms-enum": { "name": "ServiceBusTransportType", "modelAsString": "False" } + "x-ms-enum": { "name": "ServiceBusTransportType", "modelAsString": false } } } }, @@ -1241,7 +1241,7 @@ "NotSpecified", "SharedAccessKey" ], - "x-ms-enum": { "name": "ServiceBusAuthenticationType", "modelAsString": "False" } + "x-ms-enum": { "name": "ServiceBusAuthenticationType", "modelAsString": false } } } }, @@ -1312,7 +1312,7 @@ "None", "Fixed" ], - "x-ms-enum": { "name": "RetryType", "modelAsString": "False" } + "x-ms-enum": { "name": "RetryType", "modelAsString": false } }, "retryInterval": { "type": "string", @@ -1337,7 +1337,7 @@ "Week", "Month" ], - "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": "False" } + "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": false } }, "interval": { "type": "integer", @@ -1357,7 +1357,7 @@ "Week", "Month" ], - "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": "False" } + "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": false } }, "interval": { "type": "integer", @@ -1387,7 +1387,7 @@ "Week", "Month" ], - "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": "False" } + "x-ms-enum": { "name": "RecurrenceFrequency", "modelAsString": false } }, "JobRecurrenceSchedule": { "properties": { @@ -1404,7 +1404,7 @@ "Saturday", "Sunday" ], - "x-ms-enum": { "name": "DayOfWeek", "modelAsString": "False" } + "x-ms-enum": { "name": "DayOfWeek", "modelAsString": false } }, "description": "Gets or sets the days of the week that the job should execute on." }, @@ -1452,7 +1452,7 @@ "Saturday", "Sunday" ], - "x-ms-enum": { "name": "JobScheduleDay", "modelAsString": "False" } + "x-ms-enum": { "name": "JobScheduleDay", "modelAsString": false } }, "Occurrence": { "type": "integer", @@ -1478,7 +1478,7 @@ "Faulted", "Completed" ], - "x-ms-enum": { "name": "JobState", "modelAsString": "False" } + "x-ms-enum": { "name": "JobState", "modelAsString": false } }, "JobHistoryFilter": { "type": "object", @@ -1497,7 +1497,7 @@ "Failed", "Postponed" ], - "x-ms-enum": { "name": "JobExecutionStatus", "modelAsString": "False" } + "x-ms-enum": { "name": "JobExecutionStatus", "modelAsString": false } }, "JobStatus": { "properties": { diff --git a/arm-scheduler/2016-01-01/swagger/scheduler.json b/arm-scheduler/2016-01-01/swagger/scheduler.json new file mode 100644 index 000000000000..b1eca050d310 --- /dev/null +++ b/arm-scheduler/2016-01-01/swagger/scheduler.json @@ -0,0 +1,1550 @@ +{ + "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" + ], + "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-storage/2015-05-01-preview/swagger/storage.json b/arm-storage/2015-05-01-preview/swagger/storage.json index 83c7ccaade12..6b5d88b79f92 100644 --- a/arm-storage/2015-05-01-preview/swagger/storage.json +++ b/arm-storage/2015-05-01-preview/swagger/storage.json @@ -65,7 +65,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the resource group within the user’s subscription." + "description": "The name of the resource group within the user's subscription." }, { "name": "accountName", @@ -115,7 +115,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the resource group within the user’s subscription." + "description": "The name of the resource group within the user's subscription." }, { "name": "accountName", @@ -152,7 +152,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the resource group within the user’s subscription." + "description": "The name of the resource group within the user's subscription." }, { "name": "accountName", @@ -189,7 +189,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the resource group within the user’s subscription." + "description": "The name of the resource group within the user's subscription." }, { "name": "accountName", @@ -304,7 +304,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the resource group within the user’s subscription." + "description": "The name of the resource group within the user's subscription." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -339,7 +339,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the resource group within the user’s subscription." + "description": "The name of the resource group within the user's subscription." }, { "name": "accountName", @@ -426,7 +426,7 @@ ], "x-ms-enum": { "name": "Reason", - "modelAsString": "False" + "modelAsString": false } }, "message": { @@ -450,7 +450,7 @@ ], "x-ms-enum": { "name": "AccountType", - "modelAsString": "False" + "modelAsString": false } } } @@ -510,7 +510,7 @@ ], "x-ms-enum": { "name": "ProvisioningState", - "modelAsString": "False" + "modelAsString": false } }, "accountType": { @@ -525,7 +525,7 @@ ], "x-ms-enum": { "name": "AccountType", - "modelAsString": "False" + "modelAsString": false } }, "primaryEndpoints": { @@ -545,7 +545,7 @@ ], "x-ms-enum": { "name": "AccountStatus", - "modelAsString": "False" + "modelAsString": false } }, "lastGeoFailoverTime": { @@ -566,7 +566,7 @@ ], "x-ms-enum": { "name": "AccountStatus", - "modelAsString": "False" + "modelAsString": false } }, "creationTime": { @@ -640,7 +640,7 @@ ], "x-ms-enum": { "name": "AccountType", - "modelAsString": "False" + "modelAsString": false } }, "customDomain": { @@ -672,7 +672,7 @@ ], "x-ms-enum": { "name": "KeyName", - "modelAsString": "False" + "modelAsString": false } } } @@ -705,7 +705,7 @@ ], "x-ms-enum": { "name": "UsageUnit", - "modelAsString": "False" + "modelAsString": false } }, "currentValue": { diff --git a/arm-storage/2015-06-15/swagger/storage.json b/arm-storage/2015-06-15/swagger/storage.json index ab9e69d24cf5..f19af9c23bac 100644 --- a/arm-storage/2015-06-15/swagger/storage.json +++ b/arm-storage/2015-06-15/swagger/storage.json @@ -445,7 +445,7 @@ ], "x-ms-enum": { "name": "Reason", - "modelAsString": "False" + "modelAsString": false } }, "message": { @@ -469,7 +469,7 @@ ], "x-ms-enum": { "name": "AccountType", - "modelAsString": "False" + "modelAsString": false } } }, @@ -549,7 +549,7 @@ ], "x-ms-enum": { "name": "ProvisioningState", - "modelAsString": "False" + "modelAsString": false } }, "accountType": { @@ -564,7 +564,7 @@ ], "x-ms-enum": { "name": "AccountType", - "modelAsString": "False" + "modelAsString": false } }, "primaryEndpoints": { @@ -584,7 +584,7 @@ ], "x-ms-enum": { "name": "AccountStatus", - "modelAsString": "False" + "modelAsString": false } }, "lastGeoFailoverTime": { @@ -605,7 +605,7 @@ ], "x-ms-enum": { "name": "AccountStatus", - "modelAsString": "False" + "modelAsString": false } }, "creationTime": { @@ -675,7 +675,7 @@ ], "x-ms-enum": { "name": "AccountType", - "modelAsString": "False" + "modelAsString": false } }, "customDomain": { @@ -738,7 +738,7 @@ ], "x-ms-enum": { "name": "UsageUnit", - "modelAsString": "False" + "modelAsString": false } }, "currentValue": { diff --git a/arm-web/2015-08-01/swagger/service.json b/arm-web/2015-08-01/swagger/service.json index 802e4c68c568..8c56d0718996 100644 --- a/arm-web/2015-08-01/swagger/service.json +++ b/arm-web/2015-08-01/swagger/service.json @@ -10,39 +10,70 @@ "https" ], "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": { "get": { "tags": [ - "CertificateOrders" + "Certificates" ], - "summary": "Get certificate associated with the certificate order", - "operationId": "CertificateOrders_GetCertificate", + "summary": "Get certificates for a subscription in the specified resource group.", + "operationId": "Certificates_GetCertificates", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", + "description": "Name of the resource group", "required": true, "type": "string" }, { - "name": "certificateOrderName", + "$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": "Certificate name", + "description": "Name of the resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of the certificate.", "required": true, "type": "string" }, @@ -57,7 +88,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrderCertificate" + "$ref": "#/definitions/Certificate" } } }, @@ -65,10 +96,10 @@ }, "put": { "tags": [ - "CertificateOrders" + "Certificates" ], - "summary": "Associates a Key Vault secret to a certificate store that will be used for storing the certificate once it's ready", - "operationId": "CertificateOrders_CreateOrUpdateCertificate", + "summary": "Creates or modifies an existing certificate.", + "operationId": "Certificates_CreateOrUpdateCertificate", "consumes": [ "application/json", "text/json", @@ -84,31 +115,24 @@ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", - "required": true, - "type": "string" - }, - { - "name": "certificateOrderName", - "in": "path", - "description": "Certificate name", + "description": "Name of the resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of the certificate.", "required": true, "type": "string" }, { - "name": "keyVaultCertificate", + "name": "certificateEnvelope", "in": "body", - "description": "Key Vault secret csm Id", + "description": "Details of certificate if it exists already.", "required": true, "schema": { - "$ref": "#/definitions/CertificateOrderCertificate" + "$ref": "#/definitions/Certificate" } }, { @@ -122,7 +146,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrderCertificate" + "$ref": "#/definitions/Certificate" } } }, @@ -130,10 +154,10 @@ }, "delete": { "tags": [ - "CertificateOrders" + "Certificates" ], - "summary": "Deletes the certificate associated with the certificate order", - "operationId": "CertificateOrders_DeleteCertificate", + "summary": "Delete a certificate by name in a specificed subscription and resourcegroup.", + "operationId": "Certificates_DeleteCertificate", "consumes": [], "produces": [ "application/json", @@ -145,21 +169,14 @@ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", - "required": true, - "type": "string" - }, - { - "name": "certificateOrderName", - "in": "path", - "description": "Certificate name", + "description": "Name of the resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of the certificate to be deleted.", "required": true, "type": "string" }, @@ -182,10 +199,10 @@ }, "patch": { "tags": [ - "CertificateOrders" + "Certificates" ], - "summary": "Associates a Key Vault secret to a certificate store that will be used for storing the certificate once it's ready", - "operationId": "CertificateOrders_UpdateCertificate", + "summary": "Creates or modifies an existing certificate.", + "operationId": "Certificates_UpdateCertificate", "consumes": [ "application/json", "text/json", @@ -201,32 +218,65 @@ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", - "required": true, - "type": "string" - }, - { - "name": "certificateOrderName", - "in": "path", - "description": "Certificate name", + "description": "Name of the resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of the certificate.", "required": true, "type": "string" }, { - "name": "keyVaultCertificate", + "name": "certificateEnvelope", "in": "body", - "description": "Key Vault secret csm Id", + "description": "Details of certificate if it exists already.", "required": true, "schema": { - "$ref": "#/definitions/CertificateOrderCertificate" + "$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" @@ -239,20 +289,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrderCertificate" + "type": "array", + "items": { + "$ref": "#/definitions/Csr" + } } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}": { "get": { "tags": [ - "CertificateOrders" + "Certificates" ], - "summary": "Get a certificate order", - "operationId": "CertificateOrders_GetCertificateOrder", + "summary": "Gets a certificate signing request by certificate name for a subscription in the specified resource group", + "operationId": "Certificates_GetCsr", "consumes": [], "produces": [ "application/json", @@ -264,14 +317,14 @@ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", + "description": "Name of the resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of the certificate.", "required": true, "type": "string" }, @@ -286,7 +339,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrder" + "$ref": "#/definitions/Csr" } } }, @@ -294,10 +347,10 @@ }, "put": { "tags": [ - "CertificateOrders" + "Certificates" ], - "summary": "Create or update a certificate purchase order", - "operationId": "CertificateOrders_CreateOrUpdateCertificateOrder", + "summary": "Creates or modifies an existing certificate signing request.", + "operationId": "Certificates_CreateOrUpdateCsr", "consumes": [ "application/json", "text/json", @@ -313,24 +366,24 @@ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", + "description": "Name of the resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of the certificate.", "required": true, "type": "string" }, { - "name": "certificateDistinguishedName", + "name": "csrEnvelope", "in": "body", - "description": "Distinguished name to be used for purchasing certificate", + "description": "Details of certificate signing request if it exists already.", "required": true, "schema": { - "$ref": "#/definitions/CertificateOrder" + "$ref": "#/definitions/Csr" } }, { @@ -344,7 +397,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrder" + "$ref": "#/definitions/Csr" } } }, @@ -352,10 +405,10 @@ }, "delete": { "tags": [ - "CertificateOrders" + "Certificates" ], - "summary": "Delete an existing certificate order", - "operationId": "CertificateOrders_DeleteCertificateOrder", + "summary": "Delete the certificate signing request.", + "operationId": "Certificates_DeleteCsr", "consumes": [], "produces": [ "application/json", @@ -367,14 +420,14 @@ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", + "description": "Name of the resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of the certificate signing request.", "required": true, "type": "string" }, @@ -397,10 +450,10 @@ }, "patch": { "tags": [ - "CertificateOrders" + "Certificates" ], - "summary": "Create or update a certificate purchase order", - "operationId": "CertificateOrders_UpdateCertificateOrder", + "summary": "Creates or modifies an existing certificate signing request.", + "operationId": "Certificates_UpdateCsr", "consumes": [ "application/json", "text/json", @@ -416,24 +469,24 @@ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", + "description": "Name of the resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of the certificate.", "required": true, "type": "string" }, { - "name": "certificateDistinguishedName", + "name": "csrEnvelope", "in": "body", - "description": "Distinguished name to be used for purchasing certificate", + "description": "Details of certificate signing request if it exists already.", "required": true, "schema": { - "$ref": "#/definitions/CertificateOrder" + "$ref": "#/definitions/Csr" } }, { @@ -447,20 +500,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrder" + "$ref": "#/definitions/Csr" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices": { "get": { "tags": [ - "CertificateOrders" + "ClassicMobileServices" ], - "summary": "Get certificate orders in a resource group", - "operationId": "CertificateOrders_GetCertificateOrders", + "summary": "Get all mobile services in a resource group.", + "operationId": "ClassicMobileServices_GetClassicMobileServices", "consumes": [], "produces": [ "application/json", @@ -470,7 +523,7 @@ { "name": "resourceGroupName", "in": "path", - "description": "Azure resource group name", + "description": "Name of resource group", "required": true, "type": "string" }, @@ -485,37 +538,84 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrderCollection" + "$ref": "#/definitions/ClassicMobileServiceCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CertificateRegistration/certificateOrders/{certificateOrderName}/certificates": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}": { "get": { "tags": [ - "CertificateOrders" + "ClassicMobileServices" ], - "summary": "List all certificates associated with a certificate order (only one certificate can be associated with an order at a time)", - "operationId": "CertificateOrders_GetCertificates", + "summary": "Get a mobile service.", + "operationId": "ClassicMobileServices_GetClassicMobileService", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/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": "Azure resource group name", + "description": "Name of resource group", "required": true, "type": "string" }, { - "name": "certificateOrderName", + "name": "name", "in": "path", - "description": "Certificate name", + "description": "Name of mobile service", "required": true, "type": "string" }, @@ -530,20 +630,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrderCertificateCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains": { "get": { "tags": [ - "Certificates" + "Domains" ], - "summary": "Get certificates for a subscription in the specified resource group.", - "operationId": "Certificates_GetCertificates", + "summary": "Lists domains under a resource group", + "operationId": "Domains_GetDomains", "consumes": [], "produces": [ "application/json", @@ -568,20 +668,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateCollection" + "$ref": "#/definitions/DomainCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}": { "get": { "tags": [ - "Certificates" + "Domains" ], - "summary": "Get a certificate by certificate name for a subscription in the specified resource group.", - "operationId": "Certificates_GetCertificate", + "summary": "Gets details of a domain", + "operationId": "Domains_GetDomain", "consumes": [], "produces": [ "application/json", @@ -598,9 +698,9 @@ "type": "string" }, { - "name": "name", + "name": "domainName", "in": "path", - "description": "Name of the certificate.", + "description": "Name of the domain", "required": true, "type": "string" }, @@ -615,7 +715,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Certificate" + "$ref": "#/definitions/Domain" } } }, @@ -623,10 +723,10 @@ }, "put": { "tags": [ - "Certificates" + "Domains" ], - "summary": "Creates or modifies an existing certificate.", - "operationId": "Certificates_CreateOrUpdateCertificate", + "summary": "Creates a domain", + "operationId": "Domains_CreateOrUpdateDomain", "consumes": [ "application/json", "text/json", @@ -642,24 +742,24 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of the resource group", + "description": ">Name of the resource group", "required": true, "type": "string" }, { - "name": "name", + "name": "domainName", "in": "path", - "description": "Name of the certificate.", + "description": "Name of the domain", "required": true, "type": "string" }, { - "name": "certificateEnvelope", + "name": "domain", "in": "body", - "description": "Details of certificate if it exists already.", + "description": "Domain registration information", "required": true, "schema": { - "$ref": "#/definitions/Certificate" + "$ref": "#/definitions/Domain" } }, { @@ -670,10 +770,16 @@ } ], "responses": { + "202": { + "description": "Domain purchase is in progress", + "schema": { + "$ref": "#/definitions/Domain" + } + }, "200": { - "description": "OK", + "description": "Domain purchase was successful", "schema": { - "$ref": "#/definitions/Certificate" + "$ref": "#/definitions/Domain" } } }, @@ -681,10 +787,10 @@ }, "delete": { "tags": [ - "Certificates" + "Domains" ], - "summary": "Delete a certificate by name in a specificed subscription and resourcegroup.", - "operationId": "Certificates_DeleteCertificate", + "summary": "Deletes a domain", + "operationId": "Domains_DeleteDomain", "consumes": [], "produces": [ "application/json", @@ -701,12 +807,18 @@ "type": "string" }, { - "name": "name", + "name": "domainName", "in": "path", - "description": "Name of the certificate to be deleted.", + "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" }, @@ -715,8 +827,8 @@ } ], "responses": { - "200": { - "description": "OK", + "204": { + "description": "Domain does not exist in Azure database probably because it has already been deleted", "schema": { "$ref": "#/definitions/Object" } @@ -726,10 +838,10 @@ }, "patch": { "tags": [ - "Certificates" + "Domains" ], - "summary": "Creates or modifies an existing certificate.", - "operationId": "Certificates_UpdateCertificate", + "summary": "Creates a domain", + "operationId": "Domains_UpdateDomain", "consumes": [ "application/json", "text/json", @@ -745,24 +857,24 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of the resource group", + "description": ">Name of the resource group", "required": true, "type": "string" }, { - "name": "name", + "name": "domainName", "in": "path", - "description": "Name of the certificate.", + "description": "Name of the domain", "required": true, "type": "string" }, { - "name": "certificateEnvelope", + "name": "domain", "in": "body", - "description": "Details of certificate if it exists already.", + "description": "Domain registration information", "required": true, "schema": { - "$ref": "#/definitions/Certificate" + "$ref": "#/definitions/Domain" } }, { @@ -773,23 +885,29 @@ } ], "responses": { + "202": { + "description": "Domain purchase is in progress", + "schema": { + "$ref": "#/definitions/Domain" + } + }, "200": { - "description": "OK", + "description": "Domain purchase was successful", "schema": { - "$ref": "#/definitions/Certificate" + "$ref": "#/definitions/Domain" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}": { "get": { "tags": [ - "Certificates" + "Domains" ], - "summary": "Gets the certificate signing requests for a subscription in the specified resource group", - "operationId": "Certificates_GetCsrs", + "summary": "Retrieves the latest status of a domain purchase operation", + "operationId": "Domains_GetDomainOperation", "consumes": [], "produces": [ "application/json", @@ -805,6 +923,20 @@ "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" }, @@ -813,26 +945,32 @@ } ], "responses": { + "202": { + "description": "Domain purchase is in progress", + "schema": { + "$ref": "#/definitions/Domain" + } + }, "200": { - "description": "OK", + "description": "Domain purchase was successful", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Csr" - } + "$ref": "#/definitions/Domain" } + }, + "500": { + "description": "Domain purchase request failed" } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/csrs/{name}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials": { "get": { "tags": [ - "Certificates" + "Global" ], - "summary": "Gets a certificate signing request by certificate name for a subscription in the specified resource group", - "operationId": "Certificates_GetCsr", + "summary": "Gets publishing credentials for the subscription owner", + "operationId": "Global_GetSubscriptionPublishingCredentials", "consumes": [], "produces": [ "application/json", @@ -841,20 +979,6 @@ "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" }, @@ -866,7 +990,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Csr" + "$ref": "#/definitions/User" } } }, @@ -874,10 +998,10 @@ }, "put": { "tags": [ - "Certificates" + "Global" ], - "summary": "Creates or modifies an existing certificate signing request.", - "operationId": "Certificates_CreateOrUpdateCsr", + "summary": "Updates publishing credentials for the subscription owner", + "operationId": "Global_UpdateSubscriptionPublishingCredentials", "consumes": [ "application/json", "text/json", @@ -891,26 +1015,12 @@ ], "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", + "name": "requestMessage", "in": "body", - "description": "Details of certificate signing request if it exists already.", + "description": "requestMessage with new publishing credentials", "required": true, "schema": { - "$ref": "#/definitions/Csr" + "$ref": "#/definitions/User" } }, { @@ -924,40 +1034,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Csr" + "$ref": "#/definitions/User" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions": { + "get": { "tags": [ - "Certificates" + "Global" ], - "summary": "Delete the certificate signing request.", - "operationId": "Certificates_DeleteCsr", + "summary": "Gets list of available geo regions", + "operationId": "Global_GetSubscriptionGeoRegions", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "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" }, @@ -969,53 +1065,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/GeoRegionCollection" } } }, "deprecated": false - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates": { + "get": { "tags": [ - "Certificates" - ], - "summary": "Creates or modifies an existing certificate signing request.", - "operationId": "Certificates_UpdateCsr", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" + "Global" ], + "summary": "Get all certificates for a subscription", + "operationId": "Global_GetAllCertificates", + "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "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" }, @@ -1027,20 +1096,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Csr" + "$ref": "#/definitions/CertificateCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms": { "get": { "tags": [ - "ClassicMobileServices" + "Global" ], - "summary": "Get all mobile services in a resource group.", - "operationId": "ClassicMobileServices_GetClassicMobileServices", + "summary": "Gets all App Service Plans for a subcription", + "operationId": "Global_GetAllServerFarms", "consumes": [], "produces": [ "application/json", @@ -1048,11 +1117,10 @@ ], "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" + "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" @@ -1065,42 +1133,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ClassicMobileServiceCollection" + "$ref": "#/definitions/ServerFarmCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/classicMobileServices/{name}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": { "get": { "tags": [ - "ClassicMobileServices" + "Global" ], - "summary": "Get a mobile service.", - "operationId": "ClassicMobileServices_GetClassicMobileService", - "consumes": [], + "summary": "Gets all Web Apps for a subscription", + "operationId": "Global_GetAllSites", + "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "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" }, @@ -1112,40 +1164,57 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ClassicMobileService" + "$ref": "#/definitions/SiteCollection" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments": { + "get": { "tags": [ - "ClassicMobileServices" + "Global" ], - "summary": "Delete a mobile service.", - "operationId": "ClassicMobileServices_DeleteClassicMobileService", + "summary": "Gets all hostingEnvironments (App Service Environment) for a subscription", + "operationId": "Global_GetAllHostingEnvironments", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "description": "Name of resource group", - "required": true, - "type": "string" + "$ref": "#/parameters/subscriptionIdParameter" }, { - "name": "name", - "in": "path", - "description": "Name of mobile service", - "required": true, - "type": "string" - }, + "$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" }, @@ -1157,33 +1226,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/ManagedHostingEnvironmentCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/classicMobileServices": { "get": { "tags": [ - "Domains" + "Global" ], - "summary": "Lists domains under a resource group", - "operationId": "Domains_GetDomains", + "summary": "Gets all mobile services for a subscription", + "operationId": "Global_GetAllClassicMobileServices", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -1195,20 +1257,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DomainCollection" + "$ref": "#/definitions/ClassicMobileServiceCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers": { "get": { "tags": [ - "Domains" + "Global" ], - "summary": "Gets details of a domain", - "operationId": "Domains_GetDomain", + "summary": "List premier add on offers", + "operationId": "Global_ListPremierAddOnOffers", "consumes": [], "produces": [ "application/json", @@ -1217,20 +1279,6 @@ "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" }, @@ -1242,23 +1290,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Domain" + "$ref": "#/definitions/Object" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable/{name}": { + "get": { "tags": [ - "Domains" - ], - "summary": "Creates a domain", - "operationId": "Domains_CreateOrUpdateDomain", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" + "Global" ], + "summary": "Whether hosting environment name is available", + "operationId": "Global_IsHostingEnvironmentWithLegacyNameAvailable", + "consumes": [], "produces": [ "application/json", "text/json", @@ -1267,28 +1313,12 @@ ], "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "description": ">Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "domainName", + "name": "name", "in": "path", - "description": "Name of the domain", + "description": "Hosting environment name", "required": true, "type": "string" }, - { - "name": "domain", - "in": "body", - "description": "Domain registration information", - "required": true, - "schema": { - "$ref": "#/definitions/Domain" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -1297,27 +1327,23 @@ } ], "responses": { - "202": { - "description": "Domain purchase is in progress", - "schema": { - "$ref": "#/definitions/Domain" - } - }, "200": { - "description": "Domain purchase was successful", + "description": "OK", "schema": { - "$ref": "#/definitions/Domain" + "$ref": "#/definitions/Object" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable": { + "get": { "tags": [ - "Domains" + "Global" ], - "summary": "Deletes a domain", - "operationId": "Domains_DeleteDomain", + "summary": "Whether hosting environment name is available", + "operationId": "Global_IsHostingEnvironmentNameAvailable", "consumes": [], "produces": [ "application/json", @@ -1327,25 +1353,12 @@ ], "parameters": [ { - "name": "resourceGroupName", - "in": "path", - "description": "Name of the resource group", - "required": true, - "type": "string" - }, - { - "name": "domainName", - "in": "path", - "description": "Name of the domain", + "name": "name", + "in": "query", + "description": "Hosting environment name", "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" }, @@ -1354,24 +1367,28 @@ } ], "responses": { - "204": { - "description": "Domain does not exist in Azure database probably because it has already been deleted", + "200": { + "description": "OK", "schema": { "$ref": "#/definitions/Object" } } }, "deprecated": false - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability": { + "post": { "tags": [ - "Domains" + "Global" ], - "summary": "Creates a domain", - "operationId": "Domains_UpdateDomain", + "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": [ @@ -1382,26 +1399,12 @@ ], "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", + "name": "request", "in": "body", - "description": "Domain registration information", + "description": "Name availability request", "required": true, "schema": { - "$ref": "#/definitions/Domain" + "$ref": "#/definitions/ResourceNameAvailabilityRequest" } }, { @@ -1412,58 +1415,29 @@ } ], "responses": { - "202": { - "description": "Domain purchase is in progress", - "schema": { - "$ref": "#/definitions/Domain" - } - }, "200": { - "description": "Domain purchase was successful", + "description": "OK", "schema": { - "$ref": "#/definitions/Domain" + "$ref": "#/definitions/ResourceNameAvailability" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains": { "get": { "tags": [ - "Domains" + "GlobalDomainRegistration" ], - "summary": "Retrieves the latest status of a domain purchase operation", - "operationId": "Domains_GetDomainOperation", + "summary": "Lists all domains in a subscription", + "operationId": "GlobalDomainRegistration_GetAllDomains", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "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" }, @@ -1472,32 +1446,23 @@ } ], "responses": { - "202": { - "description": "Domain purchase is in progress", - "schema": { - "$ref": "#/definitions/Domain" - } - }, "200": { - "description": "Domain purchase was successful", + "description": "OK", "schema": { - "$ref": "#/definitions/Domain" + "$ref": "#/definitions/DomainCollection" } - }, - "500": { - "description": "Domain purchase request failed" } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/publishingCredentials": { - "get": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest": { + "post": { "tags": [ - "Global" + "GlobalDomainRegistration" ], - "summary": "Gets publishing credentials for the subscription owner", - "operationId": "Global_GetSubscriptionPublishingCredentials", + "summary": "Generates a single sign on request for domain management portal", + "operationId": "GlobalDomainRegistration_GetDomainControlCenterSsoRequest", "consumes": [], "produces": [ "application/json", @@ -1517,21 +1482,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/User" + "$ref": "#/definitions/DomainControlCenterSsoRequest" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/validateDomainRegistrationInformation": { + "post": { "tags": [ - "Global" + "GlobalDomainRegistration" ], - "summary": "Updates publishing credentials for the subscription owner", - "operationId": "Global_UpdateSubscriptionPublishingCredentials", + "summary": "Validates domain registration information", + "operationId": "GlobalDomainRegistration_ValidateDomainPurchaseInformation", "consumes": [ "application/json", "text/json", + "application/xml", + "text/xml", "application/x-www-form-urlencoded" ], "produces": [ @@ -1542,12 +1511,12 @@ ], "parameters": [ { - "name": "requestMessage", + "name": "domainRegistrationInput", "in": "body", - "description": "requestMessage with new publishing credentials", + "description": "Domain registration information", "required": true, "schema": { - "$ref": "#/definitions/User" + "$ref": "#/definitions/DomainRegistrationInput" } }, { @@ -1561,26 +1530,43 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/User" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions": { - "get": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability": { + "post": { "tags": [ - "Global" + "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" ], - "summary": "Gets list of available geo regions", - "operationId": "Global_GetSubscriptionGeoRegions", - "consumes": [], "produces": [ "application/json", - "text/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" }, @@ -1592,31 +1578,40 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/GeoRegionCollection" + "$ref": "#/definitions/DomainAvailablilityCheckResult" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/webhostingplans": { - "get": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations": { + "post": { "tags": [ - "Global" + "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" ], - "summary": "Gets all App Service Plans for a subcription", - "operationId": "Global_GetAllWebHostingPlans", - "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" + "name": "parameters", + "in": "body", + "description": "Domain recommendation search parameters", + "required": true, + "schema": { + "$ref": "#/definitions/DomainRecommendationSearchParameters" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -1629,31 +1624,41 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ServerFarmCollection" + "$ref": "#/definitions/NameIdentifierCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": { + "post": { "tags": [ - "Global" + "GlobalResourceGroups" ], - "summary": "Gets all App Service Plans for a subcription", - "operationId": "Global_GetAllServerFarms", - "consumes": [], - "produces": [ + "operationId": "GlobalResourceGroups_MoveResources", + "consumes": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" ], + "produces": [], "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" + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "moveResourceEnvelope", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CsmMoveResourceEnvelope" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -1663,29 +1668,42 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerFarmCollection" - } + "204": { + "description": "No Content" } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}": { "get": { "tags": [ - "Global" + "HostingEnvironments" ], - "summary": "Gets all Web Apps for a subscription", - "operationId": "Global_GetAllSites", + "summary": "Get properties of hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironment", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/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" }, @@ -1697,26 +1715,53 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteCollection" + "$ref": "#/definitions/HostingEnvironment" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments": { - "get": { + }, + "put": { "tags": [ - "Global" + "HostingEnvironments" + ], + "summary": "Create or update a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_CreateOrUpdateHostingEnvironment", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" ], - "summary": "Gets all hostingEnvironments (App Service Environment) for a subscription", - "operationId": "Global_GetAllHostingEnvironments", - "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/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" }, @@ -1728,57 +1773,62 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostingEnvironmentCollection" + "$ref": "#/definitions/HostingEnvironment" } - } - }, - "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", + "202": { + "description": "Operation is in progress", "schema": { - "$ref": "#/definitions/ManagedHostingEnvironmentCollection" + "$ref": "#/definitions/HostingEnvironment" } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" } }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/classicMobileServices": { - "get": { + "deprecated": false, + "x-ms-long-running-operation": true + }, + "delete": { "tags": [ - "Global" + "HostingEnvironments" ], - "summary": "Gets all mobile services for a subscription", - "operationId": "Global_GetAllClassicMobileServices", + "summary": "Delete a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_DeleteHostingEnvironment", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/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" }, @@ -1790,20 +1840,36 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ClassicMobileServiceCollection" + "$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 + "deprecated": false, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics": { "get": { "tags": [ - "Global" + "HostingEnvironments" ], - "summary": "List premier add on offers", - "operationId": "Global_ListPremierAddOnOffers", + "summary": "Get diagnostic information for hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentDiagnostics", "consumes": [], "produces": [ "application/json", @@ -1812,6 +1878,20 @@ "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" }, @@ -1823,20 +1903,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "type": "array", + "items": { + "$ref": "#/definitions/HostingEnvironmentDiagnostics" + } } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}": { "get": { "tags": [ - "Global" + "HostingEnvironments" ], - "summary": "Whether hosting environment name is available", - "operationId": "Global_IsHostingEnvironmentNameAvailable", + "summary": "Get diagnostic information for hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentDiagnosticsItem", "consumes": [], "produces": [ "application/json", @@ -1845,10 +1928,24 @@ "text/xml" ], "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, { "name": "name", - "in": "query", - "description": "Hosting environment 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" }, @@ -1863,32 +1960,37 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/HostingEnvironmentDiagnostics" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/ishostingenvironmentnameavailable/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute": { "get": { "tags": [ - "Global" + "HostingEnvironments" ], - "summary": "Whether hosting environment name is available", - "operationId": "Global_IsHostingEnvironmentWithLegacyNameAvailable", + "summary": "Get used, available, and total worker capacity for hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentCapacities", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" + }, { "name": "name", "in": "path", - "description": "Hosting environment name", + "description": "Name of hostingEnvironment (App Service Environment)", "required": true, "type": "string" }, @@ -1903,27 +2005,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/StampCapacityCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip": { + "get": { "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" + "HostingEnvironments" ], + "summary": "Get IP addresses assigned to the hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentVips", + "consumes": [], "produces": [ "application/json", "text/json", @@ -1932,13 +2028,18 @@ ], "parameters": [ { - "name": "request", - "in": "body", - "description": "Name availability request", + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", "required": true, - "schema": { - "$ref": "#/definitions/ResourceNameAvailabilityRequest" - } + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -1951,26 +2052,33 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResourceNameAvailability" + "$ref": "#/definitions/AddressResponse" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.CertificateRegistration/certificateOrders": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments": { "get": { "tags": [ - "GlobalCertificateOrder" + "HostingEnvironments" ], - "summary": "Lists all domains in a subscription", - "operationId": "GlobalCertificateOrder_GetAllCertificateOrders", + "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" }, @@ -1982,26 +2090,42 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CertificateOrderCollection" + "$ref": "#/definitions/HostingEnvironmentCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": { + "post": { "tags": [ - "GlobalDomainRegistration" + "HostingEnvironments" ], - "summary": "Lists all domains in a subscription", - "operationId": "GlobalDomainRegistration_GetAllDomains", + "summary": "Reboots all machines in a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_RebootHostingEnvironment", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/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" }, @@ -2010,23 +2134,32 @@ } ], "responses": { - "200": { - "description": "OK", + "202": { + "description": "Asynchronous operation in progress", "schema": { - "$ref": "#/definitions/DomainCollection" + "$ref": "#/definitions/Object" } - } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" + } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations": { + "get": { "tags": [ - "GlobalDomainRegistration" + "HostingEnvironments" ], - "summary": "Generates a single sign on request for domain management portal", - "operationId": "GlobalDomainRegistration_GetDomainControlCenterSsoRequest", + "summary": "List all currently running operations on the hostingEnvironment (App Service Environment)", + "operationId": "HostingEnvironments_GetHostingEnvironmentOperations", "consumes": [], "produces": [ "application/json", @@ -2036,52 +2169,18 @@ ], "parameters": [ { - "$ref": "#/parameters/subscriptionIdParameter" + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", + "required": true, + "type": "string" }, { - "$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", + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", "required": true, - "schema": { - "$ref": "#/definitions/DomainRegistrationInput" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -2101,20 +2200,14 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}": { + "get": { "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" + "HostingEnvironments" ], + "summary": "Get status of an operation on a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentOperation", + "consumes": [], "produces": [ "application/json", "text/json", @@ -2123,13 +2216,25 @@ ], "parameters": [ { - "name": "identifier", - "in": "body", - "description": "Name of the domain", + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", "required": true, - "schema": { - "$ref": "#/definitions/NameIdentifier" - } + "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" @@ -2140,42 +2245,65 @@ ], "responses": { "200": { - "description": "OK", + "description": "Operation completed successfully", "schema": { - "$ref": "#/definitions/DomainAvailablilityCheckResult" + "$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}/providers/Microsoft.DomainRegistration/listDomainRecommendations": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics": { + "get": { "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" + "HostingEnvironments" ], + "summary": "Get global metrics of hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMetrics", + "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Domain recommendation search parameters", + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", "required": true, - "schema": { - "$ref": "#/definitions/DomainRecommendationSearchParameters" - } + "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" @@ -2188,41 +2316,41 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/NameIdentifierCollection" + "$ref": "#/definitions/ResourceMetricCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions": { + "get": { "tags": [ - "GlobalResourceGroups" + "HostingEnvironments" ], - "operationId": "GlobalResourceGroups_MoveResources", - "consumes": [ + "summary": "Get global metric definitions of hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMetricDefinitions", + "consumes": [], + "produces": [ "application/json", "text/json", "application/xml", - "text/xml", - "application/x-www-form-urlencoded" + "text/xml" ], - "produces": [], "parameters": [ { "name": "resourceGroupName", "in": "path", + "description": "Name of resource group", "required": true, "type": "string" }, { - "name": "moveResourceEnvelope", - "in": "body", + "name": "name", + "in": "path", + "description": "Name of hostingEnvironment (App Service Environment)", "required": true, - "schema": { - "$ref": "#/definitions/CsmMoveResourceEnvelope" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -2232,26 +2360,27 @@ } ], "responses": { - "204": { - "description": "No Content" + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetricDefinition" + } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get properties of hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironment", + "summary": "Get global usages of hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentUsages", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2268,6 +2397,12 @@ "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" }, @@ -2279,28 +2414,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostingEnvironment" + "$ref": "#/definitions/CsmUsageQuotaCollection" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics": { + "get": { "tags": [ "HostingEnvironments" ], - "summary": "Create or update a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_CreateOrUpdateHostingEnvironment", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Get metrics for a multiRole pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics", + "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2318,13 +2449,34 @@ "type": "string" }, { - "name": "hostingEnvironmentEnvelope", - "in": "body", - "description": "Properties of hostingEnvironment (App Service Environment)", - "required": true, - "schema": { - "$ref": "#/definitions/HostingEnvironment" - } + "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" @@ -2337,40 +2489,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostingEnvironment" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/HostingEnvironment" + "$ref": "#/definitions/ResourceMetricCollection" } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" } }, - "deprecated": false, - "x-ms-long-running-operation": true - }, - "delete": { + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics": { + "get": { "tags": [ "HostingEnvironments" ], - "summary": "Delete a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_DeleteHostingEnvironment", + "summary": "Get metrics for a worker pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerMetrics", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2388,11 +2524,24 @@ "type": "string" }, { - "name": "forceDelete", + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, + { + "name": "details", "in": "query", - "description": "Delete even if the hostingEnvironment (App Service Environment) contains resources", + "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" }, @@ -2404,42 +2553,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/ResourceMetricCollection" } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" } }, - "deprecated": false, - "x-ms-long-running-operation": true + "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get diagnostic information for hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentDiagnostics", + "summary": "Get metric definitions for a multiRole pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleMetricDefinitions", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2467,29 +2598,24 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/HostingEnvironmentDiagnostics" - } + "$ref": "#/definitions/MetricDefinitionCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get diagnostic information for hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentDiagnosticsItem", + "summary": "Get metric definitions for a worker pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2507,9 +2633,9 @@ "type": "string" }, { - "name": "diagnosticsName", + "name": "workerPoolName", "in": "path", - "description": "Name of the diagnostics", + "description": "Name of worker pool", "required": true, "type": "string" }, @@ -2524,20 +2650,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostingEnvironmentDiagnostics" + "$ref": "#/definitions/MetricDefinitionCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get used, available, and total worker capacity for hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentCapacities", + "summary": "Get usages for a multiRole pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleUsages", "consumes": [], "produces": [ "application/json", @@ -2569,26 +2695,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StampCapacityCollection" + "$ref": "#/definitions/UsageCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get IP addresses assigned to the hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentVips", + "summary": "Get usages for a worker pool of a hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerUsages", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2605,6 +2729,13 @@ "required": true, "type": "string" }, + { + "name": "workerPoolName", + "in": "path", + "description": "Name of worker pool", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -2616,20 +2747,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AddressResponse" + "$ref": "#/definitions/UsageCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get all hostingEnvironments (App Service Environments) in a resource group.", - "operationId": "HostingEnvironments_GetHostingEnvironments", + "summary": "Get all sites on the hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentSites", "consumes": [], "produces": [ "application/json", @@ -2643,6 +2774,19 @@ "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" }, @@ -2654,26 +2798,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostingEnvironmentCollection" + "$ref": "#/definitions/SiteCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms": { + "get": { "tags": [ "HostingEnvironments" ], - "summary": "Reboots all machines in a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_RebootHostingEnvironment", + "summary": "Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentServerFarms", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2698,38 +2840,27 @@ } ], "responses": { - "202": { - "description": "Asynchronous operation in progress", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/ServerFarmCollection" } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "List all currently running operations on the hostingEnvironment (App Service Environment)", - "operationId": "HostingEnvironments_GetHostingEnvironmentOperations", + "summary": "Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).", + "operationId": "HostingEnvironments_GetHostingEnvironmentWebHostingPlans", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2757,26 +2888,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/ServerFarmCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get status of an operation on a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentOperation", + "summary": "Get all multi role pools", + "operationId": "HostingEnvironments_GetMultiRolePools", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -2793,13 +2922,6 @@ "required": true, "type": "string" }, - { - "name": "operationId", - "in": "path", - "description": "operation identifier GUID", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -2809,38 +2931,28 @@ ], "responses": { "200": { - "description": "Operation completed successfully", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "202": { - "description": "Asynchronous operation in progress", + "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/WorkerPoolCollection" } - }, - "404": { - "description": "Not found" - }, - "500": { - "description": "Operation failed" } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get global metrics of hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMetrics", - "consumes": [], + "summary": "Get properties of a multiRool pool.", + "operationId": "HostingEnvironments_GetMultiRolePool", + "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -2857,18 +2969,6 @@ "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" }, @@ -2880,21 +2980,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResourceMetricCollection" + "$ref": "#/definitions/WorkerPool" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions": { - "get": { + }, + "put": { "tags": [ "HostingEnvironments" ], - "summary": "Get global metric definitions of hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMetricDefinitions", - "consumes": [], + "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", @@ -2916,6 +3018,15 @@ "required": true, "type": "string" }, + { + "name": "multiRolePoolEnvelope", + "in": "body", + "description": "Properties of multiRole pool", + "required": true, + "schema": { + "$ref": "#/definitions/WorkerPool" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -2927,20 +3038,36 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MetricDefinition" + "$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 + "deprecated": false, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get global usages of hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentUsages", + "summary": "Get available skus for scaling a multiRole pool.", + "operationId": "HostingEnvironments_GetMultiRolePoolSkus", "consumes": [], "produces": [ "application/json", @@ -2961,12 +3088,6 @@ "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" }, @@ -2978,20 +3099,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CsmUsageQuotaCollection" + "$ref": "#/definitions/SkuInfoCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get metrics for a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleMetrics", + "summary": "Get all worker pools", + "operationId": "HostingEnvironments_GetWorkerPools", "consumes": [], "produces": [ "application/json", @@ -3012,36 +3133,6 @@ "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" }, @@ -3053,24 +3144,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResourceMetricCollection" + "$ref": "#/definitions/WorkerPoolCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get metrics for a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerMetrics", + "summary": "Get properties of a worker pool.", + "operationId": "HostingEnvironments_GetWorkerPool", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3094,18 +3187,6 @@ "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" }, @@ -3117,24 +3198,28 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResourceMetricCollection" + "$ref": "#/definitions/WorkerPool" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions": { - "get": { + }, + "put": { "tags": [ "HostingEnvironments" ], - "summary": "Get metric definitions for a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleMetricDefinitions", - "consumes": [], + "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" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3151,6 +3236,22 @@ "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" }, @@ -3162,20 +3263,36 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" + "$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 + "deprecated": false, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get metric definitions for a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerMetricDefinitions", + "summary": "Get available skus for scaling a worker pool.", + "operationId": "HostingEnvironments_GetWorkerPoolSkus", "consumes": [], "produces": [ "application/json", @@ -3214,24 +3331,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" + "$ref": "#/definitions/SkuInfoCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get usages for a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentMultiRoleUsages", + "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" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3248,6 +3367,32 @@ "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" }, @@ -3259,24 +3404,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/UsageCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get usages for a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentWebWorkerUsages", + "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" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3301,8 +3448,15 @@ "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" - }, + "name": "instance", + "in": "path", + "description": "Name of instance in the worker pool", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, { "$ref": "#/parameters/apiVersionParameter" } @@ -3311,24 +3465,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/UsageCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get all sites on the hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentSites", + "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" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3346,11 +3502,18 @@ "type": "string" }, { - "name": "propertiesToInclude", - "in": "query", - "description": "Comma separated list of site properties to include", + "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" }, @@ -3362,24 +3525,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions": { "get": { "tags": [ "HostingEnvironments" ], - "summary": "Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentServerFarms", + "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" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3396,6 +3561,13 @@ "required": true, "type": "string" }, + { + "name": "instance", + "in": "path", + "description": "Name of instance in the multiRole pool>", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3407,20 +3579,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ServerFarmCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend": { + "post": { "tags": [ "HostingEnvironments" ], - "summary": "Get all serverfarms (App Service Plans) on the hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetHostingEnvironmentWebHostingPlans", + "summary": "Suspends the hostingEnvironment.", + "operationId": "HostingEnvironments_SuspendHostingEnvironment", "consumes": [], "produces": [ "application/json", @@ -3452,20 +3624,27 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ServerFarmCollection" + "$ref": "#/definitions/SiteCollection" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/SiteCollection" } } }, - "deprecated": false + "deprecated": false, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume": { + "post": { "tags": [ "HostingEnvironments" ], - "summary": "Get all multi role pools", - "operationId": "HostingEnvironments_GetMultiRolePools", + "summary": "Resumes the hostingEnvironment.", + "operationId": "HostingEnvironments_ResumeHostingEnvironment", "consumes": [], "produces": [ "application/json", @@ -3497,20 +3676,27 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkerPoolCollection" + "$ref": "#/definitions/SiteCollection" + } + }, + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/SiteCollection" } } }, - "deprecated": false + "deprecated": false, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}": { "get": { "tags": [ - "HostingEnvironments" + "ManagedHostingEnvironments" ], - "summary": "Get properties of a multiRool pool.", - "operationId": "HostingEnvironments_GetMultiRolePool", + "summary": "Get properties of a managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironment", "consumes": [], "produces": [ "application/json", @@ -3529,7 +3715,7 @@ { "name": "name", "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", + "description": "Name of managed hosting environment", "required": true, "type": "string" }, @@ -3544,7 +3730,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkerPool" + "$ref": "#/definitions/ManagedHostingEnvironment" } } }, @@ -3552,10 +3738,10 @@ }, "put": { "tags": [ - "HostingEnvironments" + "ManagedHostingEnvironments" ], - "summary": "Create or update a multiRole pool.", - "operationId": "HostingEnvironments_CreateOrUpdateMultiRolePool", + "summary": "Create or update a managed hosting environment.", + "operationId": "ManagedHostingEnvironments_CreateOrUpdateManagedHostingEnvironment", "consumes": [ "application/json", "text/json", @@ -3578,17 +3764,17 @@ { "name": "name", "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", + "description": "Name of managed hosting environment", "required": true, "type": "string" }, { - "name": "multiRolePoolEnvelope", + "name": "ManagedHostingEnvironmentEnvelope", "in": "body", - "description": "Properties of multiRole pool", + "description": "Properties of managed hosting environment", "required": true, "schema": { - "$ref": "#/definitions/WorkerPool" + "$ref": "#/definitions/HostingEnvironment" } }, { @@ -3599,16 +3785,10 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkerPool" - } - }, "202": { - "description": "Operation is in progress", + "description": "Asynchronous operation in progress", "schema": { - "$ref": "#/definitions/WorkerPool" + "$ref": "#/definitions/HostingEnvironment" } }, "400": { @@ -3623,19 +3803,19 @@ }, "deprecated": false, "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus": { - "get": { + }, + "delete": { "tags": [ - "HostingEnvironments" + "ManagedHostingEnvironments" ], - "summary": "Get available skus for scaling a multiRole pool.", - "operationId": "HostingEnvironments_GetMultiRolePoolSkus", + "summary": "Delete a managed hosting environment.", + "operationId": "ManagedHostingEnvironments_DeleteManagedHostingEnvironment", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -3648,10 +3828,16 @@ { "name": "name", "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", + "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" }, @@ -3660,23 +3846,33 @@ } ], "responses": { - "200": { - "description": "OK", + "202": { + "description": "Asynchronous operation in progress", "schema": { - "$ref": "#/definitions/SkuInfoCollection" + "$ref": "#/definitions/Object" } + }, + "400": { + "description": "Bad request" + }, + "404": { + "description": "Not found" + }, + "409": { + "description": "Conflict" } }, - "deprecated": false + "deprecated": false, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments": { "get": { "tags": [ - "HostingEnvironments" + "ManagedHostingEnvironments" ], - "summary": "Get all worker pools", - "operationId": "HostingEnvironments_GetWorkerPools", + "summary": "Get all managed hosting environments in a resource group.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironments", "consumes": [], "produces": [ "application/json", @@ -3690,13 +3886,6 @@ "required": true, "type": "string" }, - { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3708,20 +3897,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkerPoolCollection" + "$ref": "#/definitions/HostingEnvironmentCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/capacities/virtualip": { "get": { "tags": [ - "HostingEnvironments" + "ManagedHostingEnvironments" ], - "summary": "Get properties of a worker pool.", - "operationId": "HostingEnvironments_GetWorkerPool", + "summary": "Get list of ip addresses assigned to a managed hosting environment", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentVips", "consumes": [], "produces": [ "application/json", @@ -3740,14 +3929,7 @@ { "name": "name", "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", - "required": true, - "type": "string" - }, - { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", + "description": "Name of managed hosting environment", "required": true, "type": "string" }, @@ -3762,23 +3944,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/WorkerPool" + "$ref": "#/definitions/AddressResponse" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/operations/{operationId}": { + "get": { "tags": [ - "HostingEnvironments" - ], - "summary": "Create or update a worker pool.", - "operationId": "HostingEnvironments_CreateOrUpdateWorkerPool", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" + "ManagedHostingEnvironments" ], + "summary": "Get status of an operation on a managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentOperation", + "consumes": [], "produces": [ "application/json", "text/json", @@ -3796,26 +3976,17 @@ { "name": "name", "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", + "description": "Name of managed hosting environment", "required": true, "type": "string" }, { - "name": "workerPoolName", + "name": "operationId", "in": "path", - "description": "Name of worker pool", + "description": "operation identifier GUID", "required": true, "type": "string" }, - { - "name": "workerPoolEnvelope", - "in": "body", - "description": "Properties of worker pool", - "required": true, - "schema": { - "$ref": "#/definitions/WorkerPool" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -3825,38 +3996,34 @@ ], "responses": { "200": { - "description": "OK", + "description": "Operation completed successfully", "schema": { - "$ref": "#/definitions/WorkerPool" + "$ref": "#/definitions/Object" } }, "202": { - "description": "Operation is in progress", + "description": "Asynchronous operation in progress", "schema": { - "$ref": "#/definitions/WorkerPool" + "$ref": "#/definitions/Object" } }, - "400": { - "description": "Bad request" - }, "404": { "description": "Not found" }, - "409": { - "description": "Conflict" + "500": { + "description": "Operation failed" } }, - "deprecated": false, - "x-ms-long-running-operation": true + "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites": { "get": { "tags": [ - "HostingEnvironments" + "ManagedHostingEnvironments" ], - "summary": "Get available skus for scaling a worker pool.", - "operationId": "HostingEnvironments_GetWorkerPoolSkus", + "summary": "Get all sites on the managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentSites", "consumes": [], "produces": [ "application/json", @@ -3873,15 +4040,14 @@ { "name": "name", "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", + "description": "Name of managed hosting environment", "required": true, "type": "string" }, { - "name": "workerPoolName", - "in": "path", - "description": "Name of worker pool", - "required": true, + "name": "propertiesToInclude", + "in": "query", + "description": "Comma separated list of site properties to include", "type": "string" }, { @@ -3895,26 +4061,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SkuInfoCollection" + "$ref": "#/definitions/SiteCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/webhostingplans": { "get": { "tags": [ - "HostingEnvironments" + "ManagedHostingEnvironments" ], - "summary": "Get metrics for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetWorkerPoolInstanceMetrics", + "summary": "Get all serverfarms (App Service Plans) on the managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentWebHostingPlans", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -3927,36 +4091,10 @@ { "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", + "description": "Name of managed hosting 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" }, @@ -3968,26 +4106,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/ServerFarmCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/serverfarms": { "get": { "tags": [ - "HostingEnvironments" + "ManagedHostingEnvironments" ], - "summary": "Get metric definitions for a specific instance of a worker pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetWorkerPoolInstanceMetricDefinitions", + "summary": "Get all serverfarms (App Service Plans) on the managed hosting environment.", + "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentServerFarms", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -4000,21 +4136,7 @@ { "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", + "description": "Name of managed hosting environment", "required": true, "type": "string" }, @@ -4029,58 +4151,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/ServerFarmCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics": { + "/providers/Microsoft.Web/sourcecontrols": { "get": { "tags": [ - "HostingEnvironments" + "Provider" ], - "summary": "Get metrics for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetMultiRolePoolInstanceMetrics", + "summary": "Gets the source controls available for Azure websites", + "operationId": "Provider_GetSourceControls", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "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": "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" } @@ -4089,20 +4179,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/SourceControlCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions": { + "/providers/Microsoft.Web/sourcecontrols/{sourceControlType}": { "get": { "tags": [ - "HostingEnvironments" + "Provider" ], - "summary": "Get metric definitions for a specific instance of a multiRole pool of a hostingEnvironment (App Service Environment).", - "operationId": "HostingEnvironments_GetMultiRolePoolInstanceMetricDefinitions", + "summary": "Gets source control token", + "operationId": "Provider_GetSourceControl", "consumes": [], "produces": [ "application/json", @@ -4112,29 +4202,12 @@ ], "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", + "name": "sourceControlType", "in": "path", - "description": "Name of instance in the multiRole pool>", + "description": "Type of source control", "required": true, "type": "string" }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, { "$ref": "#/parameters/apiVersionParameter" } @@ -4143,42 +4216,45 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/SourceControl" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend": { - "post": { + }, + "put": { "tags": [ - "HostingEnvironments" + "Provider" + ], + "summary": "Updates source control token", + "operationId": "Provider_UpdateSourceControl", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" ], - "summary": "Suspends the hostingEnvironment.", - "operationId": "HostingEnvironments_SuspendHostingEnvironment", - "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { - "name": "resourceGroupName", + "name": "sourceControlType", "in": "path", - "description": "Name of resource group", + "description": "Type of source control", "required": true, "type": "string" }, { - "name": "name", - "in": "path", - "description": "Name of hostingEnvironment (App Service Environment)", + "name": "requestMessage", + "in": "body", + "description": "Source control token information", "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" + "schema": { + "$ref": "#/definitions/SourceControl" + } }, { "$ref": "#/parameters/apiVersionParameter" @@ -4188,50 +4264,28 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteCollection" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/SiteCollection" + "$ref": "#/definitions/SourceControl" } } }, - "deprecated": false, - "x-ms-long-running-operation": true + "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume": { - "post": { + "/providers/Microsoft.Web/publishingUsers/web": { + "get": { "tags": [ - "HostingEnvironments" + "Provider" ], - "summary": "Resumes the hostingEnvironment.", - "operationId": "HostingEnvironments_ResumeHostingEnvironment", + "summary": "Gets publishing user", + "operationId": "Provider_GetPublishingUser", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/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" } @@ -4240,27 +4294,99 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteCollection" + "$ref": "#/definitions/User" } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/SiteCollection" + } + }, + "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, - "x-ms-long-running-operation": true + "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms": { "get": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Get properties of a managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironment", + "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", @@ -4279,7 +4405,7 @@ { "name": "name", "in": "path", - "description": "Name of managed hosting environment", + "description": "Name of App Service Plan", "required": true, "type": "string" }, @@ -4294,7 +4420,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ManagedHostingEnvironment" + "$ref": "#/definitions/ServerFarmWithRichSku" } } }, @@ -4302,10 +4428,10 @@ }, "put": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Create or update a managed hosting environment.", - "operationId": "ManagedHostingEnvironments_CreateOrUpdateManagedHostingEnvironment", + "summary": "Creates or updates an App Service Plan", + "operationId": "ServerFarms_CreateOrUpdateServerFarm", "consumes": [ "application/json", "text/json", @@ -4328,19 +4454,25 @@ { "name": "name", "in": "path", - "description": "Name of managed hosting environment", + "description": "Name of App Service Plan", "required": true, "type": "string" }, { - "name": "ManagedHostingEnvironmentEnvelope", + "name": "serverFarmEnvelope", "in": "body", - "description": "Properties of managed hosting environment", + "description": "Details of App Service Plan", "required": true, "schema": { - "$ref": "#/definitions/HostingEnvironment" + "$ref": "#/definitions/ServerFarmWithRichSku" } }, + { + "name": "allowPendingState", + "in": "query", + "description": "OBSOLETE: If true, allow pending state for App Service Plan", + "type": "boolean" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -4349,20 +4481,17 @@ } ], "responses": { - "202": { - "description": "Asynchronous operation in progress", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/HostingEnvironment" + "$ref": "#/definitions/ServerFarmWithRichSku" } }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" + "202": { + "description": "Operation is in progress", + "schema": { + "$ref": "#/definitions/ServerFarmWithRichSku" + } } }, "deprecated": false, @@ -4370,10 +4499,10 @@ }, "delete": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Delete a managed hosting environment.", - "operationId": "ManagedHostingEnvironments_DeleteManagedHostingEnvironment", + "summary": "Deletes a App Service Plan", + "operationId": "ServerFarms_DeleteServerFarm", "consumes": [], "produces": [ "application/json", @@ -4392,16 +4521,10 @@ { "name": "name", "in": "path", - "description": "Name of managed hosting environment", + "description": "Name of App Service Plan", "required": true, "type": "string" }, - { - "name": "forceDelete", - "in": "query", - "description": "Delete even if the managed hosting environment contains resources", - "type": "boolean" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -4410,33 +4533,23 @@ } ], "responses": { - "202": { - "description": "Asynchronous operation in progress", + "200": { + "description": "OK", "schema": { "$ref": "#/definitions/Object" } - }, - "400": { - "description": "Bad request" - }, - "404": { - "description": "Not found" - }, - "409": { - "description": "Conflict" } }, - "deprecated": false, - "x-ms-long-running-operation": true + "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics": { "get": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Get all managed hosting environments in a resource group.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironments", + "summary": "Queries for App Serice Plan metrics", + "operationId": "ServerFarms_GetServerFarmMetrics", "consumes": [], "produces": [ "application/json", @@ -4450,6 +4563,25 @@ "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" }, @@ -4461,26 +4593,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostingEnvironmentCollection" + "$ref": "#/definitions/ResourceMetricCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/capacities/virtualip": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions": { "get": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Get list of ip addresses assigned to a managed hosting environment", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentVips", + "summary": "List of metrics that can be queried for an App Service Plan", + "operationId": "ServerFarms_GetServerFarmMetricDefintions", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -4493,7 +4623,7 @@ { "name": "name", "in": "path", - "description": "Name of managed hosting environment", + "description": "Name of App Service Plan", "required": true, "type": "string" }, @@ -4508,20 +4638,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/AddressResponse" + "$ref": "#/definitions/MetricDefinitionCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/operations/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections": { "get": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Get status of an operation on a managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentOperation", + "summary": "Gets list of vnets associated with App Service Plan", + "operationId": "ServerFarms_GetVnetsForServerFarm", "consumes": [], "produces": [ "application/json", @@ -4540,14 +4670,7 @@ { "name": "name", "in": "path", - "description": "Name of managed hosting environment", - "required": true, - "type": "string" - }, - { - "name": "operationId", - "in": "path", - "description": "operation identifier GUID", + "description": "Name of App Service Plan", "required": true, "type": "string" }, @@ -4560,38 +4683,31 @@ ], "responses": { "200": { - "description": "Operation completed successfully", - "schema": { - "$ref": "#/definitions/Object" - } - }, - "202": { - "description": "Asynchronous operation in progress", + "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "type": "array", + "items": { + "$ref": "#/definitions/VnetInfo" + } } - }, - "404": { - "description": "Not found" - }, - "500": { - "description": "Operation failed" } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/sites": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}": { "get": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Get all sites on the managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentSites", + "summary": "Gets a vnet associated with an App Service Plan", + "operationId": "ServerFarms_GetVnetFromServerFarm", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -4604,14 +4720,15 @@ { "name": "name", "in": "path", - "description": "Name of managed hosting environment", + "description": "Name of App Service Plan", "required": true, "type": "string" }, { - "name": "propertiesToInclude", - "in": "query", - "description": "Comma separated list of site properties to include", + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", + "required": true, "type": "string" }, { @@ -4625,24 +4742,29 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteCollection" + "$ref": "#/definitions/VnetInfo" } + }, + "404": { + "description": "Virtual network could not be found" } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/webhostingplans": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes": { "get": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Get all serverfarms (App Service Plans) on the managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentWebHostingPlans", + "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" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -4655,7 +4777,14 @@ { "name": "name", "in": "path", - "description": "Name of managed hosting environment", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, + { + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", "required": true, "type": "string" }, @@ -4670,24 +4799,29 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ServerFarmCollection" + "type": "array", + "items": { + "$ref": "#/definitions/VnetRoute" + } } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/managedHostingEnvironments/{name}/serverfarms": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}": { "get": { "tags": [ - "ManagedHostingEnvironments" + "ServerFarms" ], - "summary": "Get all serverfarms (App Service Plans) on the managed hosting environment.", - "operationId": "ManagedHostingEnvironments_GetManagedHostingEnvironmentServerFarms", + "summary": "Gets a specific route associated with a vnet, in an app service plan", + "operationId": "ServerFarms_GetRouteForVnet", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -4700,78 +4834,27 @@ { "name": "name", "in": "path", - "description": "Name of managed hosting environment", + "description": "Name of App Service Plan", "required": true, "type": "string" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "name": "vnetName", + "in": "path", + "description": "Name of virtual network", + "required": true, + "type": "string" }, { - "$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", + "name": "routeName", "in": "path", - "description": "Type of source control", + "description": "Name of the virtual network route", "required": true, "type": "string" }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, { "$ref": "#/parameters/apiVersionParameter" } @@ -4780,18 +4863,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SourceControl" + "type": "array", + "items": { + "$ref": "#/definitions/VnetRoute" + } } + }, + "404": { + "description": "Specified route does not exist" } }, "deprecated": false }, "put": { "tags": [ - "Provider" + "ServerFarms" ], - "summary": "Updates source control token", - "operationId": "Provider_UpdateSourceControl", + "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", @@ -4805,21 +4894,45 @@ ], "parameters": [ { - "name": "sourceControlType", + "name": "resourceGroupName", "in": "path", - "description": "Type of source control", + "description": "Name of resource group", "required": true, "type": "string" }, { - "name": "requestMessage", + "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": "Source control token information", + "description": "The route object", "required": true, "schema": { - "$ref": "#/definitions/SourceControl" + "$ref": "#/definitions/VnetRoute" } }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, { "$ref": "#/parameters/apiVersionParameter" } @@ -4828,20 +4941,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SourceControl" + "$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 - } - }, - "/providers/Microsoft.Web/publishingUsers/web": { - "get": { + }, + "delete": { "tags": [ - "Provider" + "ServerFarms" ], - "summary": "Gets publishing user", - "operationId": "Provider_GetPublishingUser", + "summary": "Deletes an existing route for a vnet in an app service plan.", + "operationId": "ServerFarms_DeleteVnetRoute", "consumes": [], "produces": [ "application/json", @@ -4850,6 +4967,37 @@ "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" } @@ -4858,18 +5006,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/User" + "$ref": "#/definitions/Object" } + }, + "404": { + "description": "Specified route does not exist." } }, "deprecated": false }, - "put": { + "patch": { "tags": [ - "Provider" + "ServerFarms" ], - "summary": "Updates publishing user", - "operationId": "Provider_UpdatePublishingUser", + "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", @@ -4883,49 +5034,42 @@ ], "parameters": [ { - "name": "requestMessage", - "in": "body", - "description": "Details of publishing user", + "name": "resourceGroupName", + "in": "path", + "description": "Name of resource group", "required": true, - "schema": { - "$ref": "#/definitions/User" - } + "type": "string" }, { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/User" - } - } - }, - "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": "name", + "in": "path", + "description": "Name of App Service Plan", + "required": true, + "type": "string" + }, { - "name": "resourceGroupName", + "name": "vnetName", "in": "path", - "description": "Name of resource group", + "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" }, @@ -4937,20 +5081,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ServerFarmCollection" + "$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}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { "get": { "tags": [ "ServerFarms" - ], - "summary": "Gets specified App Service Plan in a resource group", - "operationId": "ServerFarms_GetServerFarm", + ], + "summary": "Gets the vnet gateway.", + "operationId": "ServerFarms_GetServerFarmVnetGateway", "consumes": [], "produces": [ "application/json", @@ -4969,7 +5119,21 @@ { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "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" }, @@ -4984,7 +5148,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" + "$ref": "#/definitions/VnetGateway" } } }, @@ -4994,8 +5158,8 @@ "tags": [ "ServerFarms" ], - "summary": "Creates or updates an App Service Plan", - "operationId": "ServerFarms_CreateOrUpdateServerFarm", + "summary": "Updates the vnet gateway", + "operationId": "ServerFarms_UpdateServerFarmVnetGateway", "consumes": [ "application/json", "text/json", @@ -5011,32 +5175,40 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "The name of the App Service Plan", "required": true, "type": "string" }, { - "name": "serverFarmEnvelope", + "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": "Details of App Service Plan", + "description": "The gateway entity.", "required": true, "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" + "$ref": "#/definitions/VnetGateway" } }, - { - "name": "allowPendingState", - "in": "query", - "description": "OBSOLETE: If true, allow pending state for App Service Plan", - "type": "boolean" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5048,31 +5220,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" - } - }, - "202": { - "description": "Operation is in progress", - "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" + "$ref": "#/definitions/VnetGateway" } } }, - "deprecated": false, - "x-ms-long-running-operation": true - }, - "delete": { + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites": { + "get": { "tags": [ "ServerFarms" ], - "summary": "Deletes a App Service Plan", - "operationId": "ServerFarms_DeleteServerFarm", + "summary": "Gets list of Apps associated with an App Service Plan", + "operationId": "ServerFarms_GetServerFarmSites", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -5089,6 +5254,24 @@ "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" }, @@ -5100,24 +5283,29 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/SiteCollection" } } }, - "deprecated": false + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metrics": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}": { + "post": { "tags": [ "ServerFarms" ], - "summary": "Queries for App Serice Plan metrics", - "operationId": "ServerFarms_GetServerFarmMetrics", + "summary": "Submit a reboot request for a worker machine in the specified server farm", + "operationId": "ServerFarms_RebootWorkerForServerFarm", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -5130,20 +5318,15 @@ { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "Name of server farm", "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]'.", + "name": "workerName", + "in": "path", + "description": "Name of worker machine, typically IP address", + "required": true, "type": "string" }, { @@ -5157,24 +5340,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResourceMetricCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/metricdefinitions": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites": { + "post": { "tags": [ "ServerFarms" ], - "summary": "List of metrics that can be queried for an App Service Plan", - "operationId": "ServerFarms_GetServerFarmMetricDefintions", + "summary": "Restarts web apps in a specified App Service Plan", + "operationId": "ServerFarms_RestartSitesForServerFarm", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -5191,6 +5376,12 @@ "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" }, @@ -5202,20 +5393,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}": { "get": { "tags": [ "ServerFarms" ], - "summary": "Gets list of vnets associated with App Service Plan", - "operationId": "ServerFarms_GetVnetsForServerFarm", + "summary": "Gets a server farm operation", + "operationId": "ServerFarms_GetServerFarmOperation", "consumes": [], "produces": [ "application/json", @@ -5234,7 +5425,14 @@ { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "Name of server farm", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Id of Server farm operation\">", "required": true, "type": "string" }, @@ -5249,23 +5447,20 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetInfo" - } + "$ref": "#/definitions/ServerFarmWithRichSku" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": { "get": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Gets a vnet associated with an App Service Plan", - "operationId": "ServerFarms_GetVnetFromServerFarm", + "summary": "Retrieves a specific Virtual Network Connection associated with this web app.", + "operationId": "Sites_GetSiteVNETConnectionSlot", "consumes": [], "produces": [ "application/json", @@ -5277,21 +5472,28 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "The name of the web app", "required": true, "type": "string" }, { "name": "vnetName", "in": "path", - "description": "Name of virtual network", + "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" }, @@ -5308,22 +5510,21 @@ "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": { + }, + "put": { "tags": [ - "ServerFarms" + "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" ], - "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", @@ -5334,21 +5535,37 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "The name of the web app", "required": true, "type": "string" }, { "name": "vnetName", "in": "path", - "description": "Name of virtual network", + "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" }, @@ -5363,23 +5580,18 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetRoute" - } + "$ref": "#/definitions/VnetInfo" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}": { - "get": { + }, + "delete": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Gets a specific route associated with a vnet, in an app service plan", - "operationId": "ServerFarms_GetRouteForVnet", + "summary": "Removes the specified Virtual Network Connection association from this web app.", + "operationId": "Sites_DeleteSiteVNETConnectionSlot", "consumes": [], "produces": [ "application/json", @@ -5391,28 +5603,28 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "The name of the web app", "required": true, "type": "string" }, { "name": "vnetName", "in": "path", - "description": "Name of virtual network", + "description": "The name of the Virtual Network", "required": true, "type": "string" }, { - "name": "routeName", + "name": "slot", "in": "path", - "description": "Name of the virtual network route", + "description": "The name of the slot for this web app.", "required": true, "type": "string" }, @@ -5427,24 +5639,18 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetRoute" - } + "$ref": "#/definitions/Object" } - }, - "404": { - "description": "Specified route does not exist" } }, "deprecated": false }, - "put": { + "patch": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Creates a new route or updates an existing route for a vnet in an app service plan.", - "operationId": "ServerFarms_CreateOrUpdateVnetRoute", + "summary": "Adds a Virtual Network Connection or updates it's properties.", + "operationId": "Sites_UpdateSiteVNETConnectionSlot", "consumes": [ "application/json", "text/json", @@ -5460,40 +5666,40 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "The name of the web app", "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", + "description": "The name of the Virtual Network", "required": true, "type": "string" }, { - "name": "route", + "name": "connectionEnvelope", "in": "body", - "description": "The route object", + "description": "The properties of this Virtual Network Connection", "required": true, "schema": { - "$ref": "#/definitions/VnetRoute" + "$ref": "#/definitions/VnetInfo" } }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -5505,24 +5711,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetRoute" + "$ref": "#/definitions/VnetInfo" } - }, - "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": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": { + "get": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Deletes an existing route for a vnet in an app service plan.", - "operationId": "ServerFarms_DeleteVnetRoute", + "summary": "Retrieves a specific Virtual Network Connection associated with this web app.", + "operationId": "Sites_GetSiteVNETConnection", "consumes": [], "produces": [ "application/json", @@ -5534,28 +5736,21 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "The name of the web app", "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", + "description": "The name of the Virtual Network", "required": true, "type": "string" }, @@ -5570,21 +5765,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/VnetInfo" } - }, - "404": { - "description": "Specified route does not exist." } }, "deprecated": false }, - "patch": { + "put": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Creates a new route or updates an existing route for a vnet in an app service plan.", - "operationId": "ServerFarms_UpdateVnetRoute", + "summary": "Adds a Virtual Network Connection or updates it's properties.", + "operationId": "Sites_CreateOrUpdateSiteVNETConnection", "consumes": [ "application/json", "text/json", @@ -5600,38 +5792,31 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "The name of the web app", "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", + "description": "The name of the Virtual Network", "required": true, "type": "string" }, { - "name": "route", + "name": "connectionEnvelope", "in": "body", - "description": "The route object", + "description": "The properties of this Virtual Network Connection", "required": true, "schema": { - "$ref": "#/definitions/VnetRoute" + "$ref": "#/definitions/VnetInfo" } }, { @@ -5645,26 +5830,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetRoute" + "$ref": "#/definitions/VnetInfo" } - }, - "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": { + }, + "delete": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Gets the vnet gateway.", - "operationId": "ServerFarms_GetServerFarmVnetGateway", + "summary": "Removes the specified Virtual Network Connection association from this web app.", + "operationId": "Sites_DeleteSiteVNETConnection", "consumes": [], "produces": [ "application/json", @@ -5676,28 +5853,21 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of the App Service Plan", + "description": "The name of the web app", "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.", + "description": "The name of the Virtual Network", "required": true, "type": "string" }, @@ -5712,18 +5882,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/Object" } } }, "deprecated": false }, - "put": { + "patch": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Updates the vnet gateway", - "operationId": "ServerFarms_UpdateServerFarmVnetGateway", + "summary": "Adds a Virtual Network Connection or updates it's properties.", + "operationId": "Sites_UpdateSiteVNETConnection", "consumes": [ "application/json", "text/json", @@ -5739,38 +5909,31 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "The name of the App Service Plan", + "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. Only 'primary' is supported.", + "description": "The name of the Virtual Network", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", - "description": "The gateway entity.", + "description": "The properties of this Virtual Network Connection", "required": true, "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/VnetInfo" } }, { @@ -5784,56 +5947,47 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/VnetInfo" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { "get": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Gets list of Apps associated with an App Service Plan", - "operationId": "ServerFarms_GetServerFarmSites", + "summary": "Retrieves a view of all network features in use on this web app.", + "operationId": "Sites_GetSiteNetworkFeatures", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "The name of the web app", "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.", + "name": "view", + "in": "path", + "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "required": true, "type": "string" }, { @@ -5847,23 +6001,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteCollection" + "$ref": "#/definitions/NetworkFeatures" } + }, + "404": { + "description": "The requested view does not exist." } }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } + "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": { + "get": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Submit a reboot request for a worker machine in the specified server farm", - "operationId": "ServerFarms_RebootWorkerForServerFarm", + "summary": "Retrieves a view of all network features in use on this web app.", + "operationId": "Sites_GetSiteNetworkFeaturesSlot", "consumes": [], "produces": [ "application/json", @@ -5875,21 +6029,28 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "Name of server farm", + "description": "The name of the web app", "required": true, "type": "string" }, { - "name": "workerName", + "name": "view", "in": "path", - "description": "Name of worker machine, typically IP address", + "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" }, @@ -5904,20 +6065,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/NetworkFeatures" } + }, + "404": { + "description": "The requested view does not exist." } }, "deprecated": false } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites": { - "post": { + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/operationresults/{operationId}": { + "get": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Restarts web apps in a specified App Service Plan", - "operationId": "ServerFarms_RestartSitesForServerFarm", + "summary": "Gets the operation for a web app", + "operationId": "Sites_GetSiteOperation", "consumes": [], "produces": [ "application/json", @@ -5936,15 +6100,16 @@ { "name": "name", "in": "path", - "description": "Name of App Service Plan", + "description": "Name of web app", "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" + "name": "operationId", + "in": "path", + "description": "Id of an operation", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -5964,13 +6129,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/operationresults/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/operationresults/{operationId}": { "get": { "tags": [ - "ServerFarms" + "Sites" ], - "summary": "Gets a server farm operation", - "operationId": "ServerFarms_GetServerFarmOperation", + "summary": "Gets the operation for a web app", + "operationId": "Sites_GetSiteOperationSlot", "consumes": [], "produces": [ "application/json", @@ -5989,14 +6154,21 @@ { "name": "name", "in": "path", - "description": "Name of server farm", + "description": "Name of web app", "required": true, "type": "string" }, { "name": "operationId", "in": "path", - "description": "Id of Server farm operation\">", + "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" }, @@ -6011,7 +6183,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ServerFarmWithRichSku" + "$ref": "#/definitions/Object" } } }, @@ -6288,13 +6460,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": { + "/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_ApplySlotConfigSlot", + "operationId": "Sites_ApplySlotConfigToProduction", "consumes": [ "application/json", "text/json", @@ -6332,13 +6504,6 @@ "$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" }, @@ -6357,13 +6522,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig": { + "/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_ApplySlotConfigToProduction", + "operationId": "Sites_ApplySlotConfigSlot", "consumes": [ "application/json", "text/json", @@ -6401,6 +6566,13 @@ "$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" }, @@ -6419,13 +6591,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": { + "/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_ResetProductionSlotConfig", + "operationId": "Sites_ResetSlotConfigSlot", "consumes": [], "produces": [ "application/json", @@ -6448,6 +6620,13 @@ "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" }, @@ -6466,13 +6645,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": { + "/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_ResetSlotConfigSlot", + "operationId": "Sites_ResetProductionSlotConfig", "consumes": [], "produces": [ "application/json", @@ -6495,13 +6674,6 @@ "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" }, @@ -7306,13 +7478,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restorableSnapshots": { + "/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_GetSiteSnapshotsOnSku", + "operationId": "Sites_GetSiteSnapshotsOnSkuSlot", "consumes": [], "produces": [ "application/json", @@ -7348,6 +7520,12 @@ "required": true, "type": "string" }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7366,13 +7544,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restorableSnapshots": { + "/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_GetSiteSnapshotsOnSkuSlot", + "operationId": "Sites_GetSiteSnapshotsOnSku", "consumes": [], "produces": [ "application/json", @@ -7408,12 +7586,6 @@ "required": true, "type": "string" }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7608,13 +7780,162 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": { "get": { "tags": [ "Sites" ], - "summary": "Gets all instance of a web app", - "operationId": "Sites_GetSiteInstanceIdentifiers", + "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}/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}/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", @@ -7629,9 +7950,23 @@ "type": "string" }, { - "name": "name", + "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": "Name of web app", + "description": "Id of web app instance", "required": true, "type": "string" }, @@ -7646,24 +7981,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteInstanceCollection" + "$ref": "#/definitions/DeploymentCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/deployments/{id}": { "get": { "tags": [ "Sites" ], - "summary": "Gets all instance of a web app", - "operationId": "Sites_GetSiteInstanceIdentifiersSlot", + "summary": "Get the deployment", + "operationId": "Sites_GetInstanceDeploymentSlot", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -7680,6 +8017,13 @@ "required": true, "type": "string" }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, { "name": "slot", "in": "path", @@ -7687,6 +8031,13 @@ "required": true, "type": "string" }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7698,24 +8049,28 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteInstanceCollection" + "$ref": "#/definitions/Deployment" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { - "get": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Get web app hostname bindings", - "operationId": "Sites_GetSiteHostNameBindings", - "consumes": [], + "summary": "Create a deployment", + "operationId": "Sites_CreateInstanceDeploymentSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -7732,6 +8087,36 @@ "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" }, @@ -7743,24 +8128,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBindingCollection" + "$ref": "#/definitions/Deployment" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": { - "get": { + }, + "delete": { "tags": [ "Sites" ], - "summary": "Get web app hostname bindings", - "operationId": "Sites_GetSiteHostNameBindingsSlot", + "summary": "Delete the deployment", + "operationId": "Sites_DeleteInstanceDeploymentSlot", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -7777,6 +8162,13 @@ "required": true, "type": "string" }, + { + "name": "id", + "in": "path", + "description": "Id of the deployment", + "required": true, + "type": "string" + }, { "name": "slot", "in": "path", @@ -7784,6 +8176,13 @@ "required": true, "type": "string" }, + { + "name": "instanceId", + "in": "path", + "description": "Id of web app instance", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -7795,20 +8194,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBindingCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}": { "get": { "tags": [ "Sites" ], - "summary": "Get web app binding for a hostname", - "operationId": "Sites_GetSiteHostNameBindingSlot", + "summary": "Get the deployment", + "operationId": "Sites_GetDeployment", "consumes": [], "produces": [ "application/json", @@ -7832,16 +8231,9 @@ "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", + "name": "id", "in": "path", - "description": "Name of host", + "description": "Id of the deployment", "required": true, "type": "string" }, @@ -7856,7 +8248,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Deployment" } } }, @@ -7866,8 +8258,8 @@ "tags": [ "Sites" ], - "summary": "Creates a web app hostname binding", - "operationId": "Sites_CreateOrUpdateSiteHostNameBindingSlot", + "summary": "Create a deployment", + "operationId": "Sites_CreateDeployment", "consumes": [ "application/json", "text/json", @@ -7895,28 +8287,21 @@ "type": "string" }, { - "name": "hostName", + "name": "id", "in": "path", - "description": "Name of host", + "description": "Id of the deployment", "required": true, "type": "string" }, { - "name": "hostNameBinding", + "name": "deployment", "in": "body", - "description": "Host name binding information", + "description": "Details of deployment", "required": true, "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Deployment" } }, - { - "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" }, @@ -7928,7 +8313,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Deployment" } } }, @@ -7938,8 +8323,8 @@ "tags": [ "Sites" ], - "summary": "Deletes a host name binding", - "operationId": "Sites_DeleteSiteHostNameBindingSlot", + "summary": "Delete the deployment", + "operationId": "Sites_DeleteDeployment", "consumes": [], "produces": [ "application/json", @@ -7963,16 +8348,9 @@ "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", + "name": "id", "in": "path", - "description": "Name of host", + "description": "Id of the deployment", "required": true, "type": "string" }, @@ -7994,13 +8372,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": { "get": { "tags": [ "Sites" ], - "summary": "Get web app binding for a hostname", - "operationId": "Sites_GetSiteHostNameBinding", + "summary": "Get the deployment", + "operationId": "Sites_GetDeploymentSlot", "consumes": [], "produces": [ "application/json", @@ -8024,9 +8402,16 @@ "type": "string" }, { - "name": "hostName", + "name": "id", "in": "path", - "description": "Name of host", + "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" }, @@ -8041,7 +8426,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Deployment" } } }, @@ -8051,8 +8436,8 @@ "tags": [ "Sites" ], - "summary": "Creates a web app hostname binding", - "operationId": "Sites_CreateOrUpdateSiteHostNameBinding", + "summary": "Create a deployment", + "operationId": "Sites_CreateDeploymentSlot", "consumes": [ "application/json", "text/json", @@ -8080,19 +8465,26 @@ "type": "string" }, { - "name": "hostName", + "name": "id", "in": "path", - "description": "Name of host", + "description": "Id of the deployment", "required": true, "type": "string" }, { - "name": "hostNameBinding", + "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": "Host name binding information", + "description": "Details of deployment", "required": true, "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Deployment" } }, { @@ -8106,7 +8498,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HostNameBinding" + "$ref": "#/definitions/Deployment" } } }, @@ -8116,8 +8508,8 @@ "tags": [ "Sites" ], - "summary": "Deletes a host name binding", - "operationId": "Sites_DeleteSiteHostNameBinding", + "summary": "Delete the deployment", + "operationId": "Sites_DeleteDeploymentSlot", "consumes": [], "produces": [ "application/json", @@ -8141,9 +8533,16 @@ "type": "string" }, { - "name": "hostName", + "name": "id", "in": "path", - "description": "Name of host", + "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" }, @@ -8165,13 +8564,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/deployments/{id}": { "get": { "tags": [ "Sites" ], - "summary": "Gets the configuration of the web app", - "operationId": "Sites_GetSiteConfig", + "summary": "Get the deployment", + "operationId": "Sites_GetInstanceDeployment", "consumes": [], "produces": [ "application/json", @@ -8194,6 +8593,20 @@ "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" }, @@ -8205,7 +8618,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfig" + "$ref": "#/definitions/Deployment" } } }, @@ -8215,8 +8628,8 @@ "tags": [ "Sites" ], - "summary": "Update the configuration of web app", - "operationId": "Sites_CreateOrUpdateSiteConfig", + "summary": "Create a deployment", + "operationId": "Sites_CreateInstanceDeployment", "consumes": [ "application/json", "text/json", @@ -8244,12 +8657,26 @@ "type": "string" }, { - "name": "siteConfig", + "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": "Request body that contains the configuraiton setting for the web app", + "description": "Details of deployment", "required": true, "schema": { - "$ref": "#/definitions/SiteConfig" + "$ref": "#/definitions/Deployment" } }, { @@ -8263,28 +8690,83 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfig" + "$ref": "#/definitions/Deployment" } } }, "deprecated": false }, - "patch": { + "delete": { "tags": [ "Sites" ], - "summary": "Update the configuration of web app", - "operationId": "Sites_UpdateSiteConfig", - "consumes": [ + "summary": "Delete the deployment", + "operationId": "Sites_DeleteInstanceDeployment", + "consumes": [], + "produces": [ "application/json", "text/json", - "application/x-www-form-urlencoded" + "application/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", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -8301,15 +8783,6 @@ "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" }, @@ -8321,26 +8794,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfig" + "$ref": "#/definitions/SiteInstanceCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": { "get": { "tags": [ "Sites" ], - "summary": "Gets the configuration of the web app", - "operationId": "Sites_GetSiteConfigSlot", + "summary": "Gets all instance of a web app", + "operationId": "Sites_GetSiteInstanceIdentifiersSlot", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -8375,28 +8846,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfig" + "$ref": "#/definitions/SiteInstanceCollection" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": { + "get": { "tags": [ "Sites" ], - "summary": "Update the configuration of web app", - "operationId": "Sites_CreateOrUpdateSiteConfigSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Get web app hostname bindings", + "operationId": "Sites_GetSiteHostNameBindingsSlot", + "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -8413,15 +8880,6 @@ "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", @@ -8440,28 +8898,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfig" + "$ref": "#/definitions/HostNameBindingCollection" } } }, "deprecated": false - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": { + "get": { "tags": [ "Sites" ], - "summary": "Update the configuration of web app", - "operationId": "Sites_UpdateSiteConfigSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Get web app hostname bindings", + "operationId": "Sites_GetSiteHostNameBindings", + "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -8478,22 +8932,6 @@ "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" }, @@ -8505,20 +8943,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteConfig" + "$ref": "#/definitions/HostNameBindingCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": { "get": { "tags": [ "Sites" ], - "summary": "Get the source control configuration of web app", - "operationId": "Sites_GetSiteSourceControl", + "summary": "Get web app binding for a hostname", + "operationId": "Sites_GetSiteHostNameBinding", "consumes": [], "produces": [ "application/json", @@ -8541,6 +8979,13 @@ "required": true, "type": "string" }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -8552,7 +8997,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/HostNameBinding" } } }, @@ -8562,8 +9007,8 @@ "tags": [ "Sites" ], - "summary": "Update the source control configuration of web app", - "operationId": "Sites_CreateOrUpdateSiteSourceControl", + "summary": "Creates a web app hostname binding", + "operationId": "Sites_CreateOrUpdateSiteHostNameBinding", "consumes": [ "application/json", "text/json", @@ -8591,12 +9036,19 @@ "type": "string" }, { - "name": "siteSourceControl", + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, + { + "name": "hostNameBinding", "in": "body", - "description": "Request body that contains the source control parameters", + "description": "Host name binding information", "required": true, "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/HostNameBinding" } }, { @@ -8610,7 +9062,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/HostNameBinding" } } }, @@ -8620,8 +9072,8 @@ "tags": [ "Sites" ], - "summary": "Delete source control configuration of web app", - "operationId": "Sites_DeleteSiteSourceControl", + "summary": "Deletes a host name binding", + "operationId": "Sites_DeleteSiteHostNameBinding", "consumes": [], "produces": [ "application/json", @@ -8644,6 +9096,13 @@ "required": true, "type": "string" }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -8660,18 +9119,16 @@ } }, "deprecated": false - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": { + "get": { "tags": [ "Sites" ], - "summary": "Update the source control configuration of web app", - "operationId": "Sites_UpdateSiteSourceControl", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Get web app binding for a hostname", + "operationId": "Sites_GetSiteHostNameBindingSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -8694,13 +9151,18 @@ "type": "string" }, { - "name": "siteSourceControl", - "in": "body", - "description": "Request body that contains the source control parameters", + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } + "type": "string" + }, + { + "name": "hostName", + "in": "path", + "description": "Name of host", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -8713,21 +9175,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/HostNameBinding" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": { - "get": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Get the source control configuration of web app", - "operationId": "Sites_GetSiteSourceControlSlot", - "consumes": [], + "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", @@ -8749,6 +9213,22 @@ "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", @@ -8767,23 +9247,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/HostNameBinding" } } }, "deprecated": false }, - "put": { + "delete": { "tags": [ "Sites" ], - "summary": "Update the source control configuration of web app", - "operationId": "Sites_CreateOrUpdateSiteSourceControlSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Deletes a host name binding", + "operationId": "Sites_DeleteSiteHostNameBindingSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -8806,18 +9282,16 @@ "type": "string" }, { - "name": "siteSourceControl", - "in": "body", - "description": "Request body that contains the source control parameters", + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, - "schema": { - "$ref": "#/definitions/SiteSourceControl" - } + "type": "string" }, { - "name": "slot", + "name": "hostName", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Name of host", "required": true, "type": "string" }, @@ -8832,18 +9306,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/Object" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": { + "get": { "tags": [ "Sites" ], - "summary": "Delete source control configuration of web app", - "operationId": "Sites_DeleteSiteSourceControlSlot", + "summary": "Gets the configuration of the web app", + "operationId": "Sites_GetSiteConfig", "consumes": [], "produces": [ "application/json", @@ -8866,13 +9342,6 @@ "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" }, @@ -8884,18 +9353,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/SiteConfig" } } }, "deprecated": false }, - "patch": { + "put": { "tags": [ "Sites" ], - "summary": "Update the source control configuration of web app", - "operationId": "Sites_UpdateSiteSourceControlSlot", + "summary": "Update the configuration of web app", + "operationId": "Sites_CreateOrUpdateSiteConfig", "consumes": [ "application/json", "text/json", @@ -8923,21 +9392,14 @@ "type": "string" }, { - "name": "siteSourceControl", + "name": "siteConfig", "in": "body", - "description": "Request body that contains the source control parameters", + "description": "Request body that contains the configuraiton setting for the web app", "required": true, "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$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" }, @@ -8949,21 +9411,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteSourceControl" + "$ref": "#/definitions/SiteConfig" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": { - "post": { + }, + "patch": { "tags": [ "Sites" ], - "summary": "Gets the application settings of web app", - "operationId": "Sites_ListSiteAppSettings", - "consumes": [], + "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", @@ -8985,6 +9449,15 @@ "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" }, @@ -8996,20 +9469,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteConfig" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": { + "get": { "tags": [ "Sites" ], - "summary": "Gets the application settings of web app", - "operationId": "Sites_ListSiteAppSettingsSlot", + "summary": "Gets the configuration of the web app", + "operationId": "Sites_GetSiteConfigSlot", "consumes": [], "produces": [ "application/json", @@ -9050,20 +9523,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteConfig" } } }, "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", + "summary": "Update the configuration of web app", + "operationId": "Sites_CreateOrUpdateSiteConfigSlot", "consumes": [ "application/json", "text/json", @@ -9091,14 +9562,21 @@ "type": "string" }, { - "name": "appSettings", + "name": "siteConfig", "in": "body", - "description": "Application settings of web app", + "description": "Request body that contains the configuraiton setting for the web app", "required": true, "schema": { - "$ref": "#/definitions/StringDictionary" + "$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" }, @@ -9110,20 +9588,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteConfig" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { - "put": { + }, + "patch": { "tags": [ "Sites" ], - "summary": "Updates the application settings of web app", - "operationId": "Sites_UpdateSiteAppSettingsSlot", + "summary": "Update the configuration of web app", + "operationId": "Sites_UpdateSiteConfigSlot", "consumes": [ "application/json", "text/json", @@ -9151,12 +9627,12 @@ "type": "string" }, { - "name": "appSettings", + "name": "siteConfig", "in": "body", - "description": "Application settings of web app", + "description": "Request body that contains the configuraiton setting for the web app", "required": true, "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteConfig" } }, { @@ -9177,20 +9653,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/SiteConfig" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": { + "get": { "tags": [ "Sites" ], - "summary": "Gets the connection strings associated with web app", - "operationId": "Sites_ListSiteConnectionStrings", + "summary": "Get the source control configuration of web app", + "operationId": "Sites_GetSiteSourceControlSlot", "consumes": [], "produces": [ "application/json", @@ -9213,6 +9689,13 @@ "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" }, @@ -9224,21 +9707,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteSourceControl" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { - "post": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Gets the connection strings associated with web app", - "operationId": "Sites_ListSiteConnectionStringsSlot", - "consumes": [], + "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", @@ -9260,6 +9745,15 @@ "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", @@ -9278,25 +9772,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteSourceControl" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": { - "put": { + }, + "delete": { "tags": [ "Sites" ], - "summary": "Updates the connection strings associated with web app", - "operationId": "Sites_UpdateSiteConnectionStrings", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Delete source control configuration of web app", + "operationId": "Sites_DeleteSiteSourceControlSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -9319,13 +9807,11 @@ "type": "string" }, { - "name": "connectionStrings", - "in": "body", - "description": "Connection strings associated with web app", + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, - "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -9338,20 +9824,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/Object" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { - "put": { + }, + "patch": { "tags": [ "Sites" ], - "summary": "Updates the connection strings associated with web app", - "operationId": "Sites_UpdateSiteConnectionStringsSlot", + "summary": "Update the source control configuration of web app", + "operationId": "Sites_UpdateSiteSourceControlSlot", "consumes": [ "application/json", "text/json", @@ -9379,12 +9863,12 @@ "type": "string" }, { - "name": "connectionStrings", + "name": "siteSourceControl", "in": "body", - "description": "Connection strings associated with web app", + "description": "Request body that contains the source control parameters", "required": true, "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteSourceControl" } }, { @@ -9405,20 +9889,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ConnectionStringDictionary" + "$ref": "#/definitions/SiteSourceControl" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": { + "get": { "tags": [ "Sites" ], - "summary": "Gets the Authentication / Authorization settings associated with web app", - "operationId": "Sites_ListSiteAuthSettings", + "summary": "Get the source control configuration of web app", + "operationId": "Sites_GetSiteSourceControl", "consumes": [], "produces": [ "application/json", @@ -9452,21 +9936,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/SiteSourceControl" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { - "post": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Gets the Authentication / Authorization settings associated with web app", - "operationId": "Sites_ListSiteAuthSettingsSlot", - "consumes": [], + "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", @@ -9489,11 +9975,13 @@ "type": "string" }, { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "name": "siteSourceControl", + "in": "body", + "description": "Request body that contains the source control parameters", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/SiteSourceControl" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -9506,25 +9994,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/SiteSourceControl" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": { - "put": { + }, + "delete": { "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" - ], + "summary": "Delete source control configuration of web app", + "operationId": "Sites_DeleteSiteSourceControl", + "consumes": [], "produces": [ "application/json", "text/json", @@ -9543,17 +10025,8 @@ "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" - } + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -9566,20 +10039,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/Object" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { - "put": { + }, + "patch": { "tags": [ "Sites" ], - "summary": "Updates the Authentication / Authorization settings associated with web app", - "operationId": "Sites_UpdateSiteAuthSettingsSlot", + "summary": "Update the source control configuration of web app", + "operationId": "Sites_UpdateSiteSourceControl", "consumes": [ "application/json", "text/json", @@ -9607,21 +10078,14 @@ "type": "string" }, { - "name": "siteAuthSettings", + "name": "siteSourceControl", "in": "body", - "description": "Auth settings associated with web app", + "description": "Request body that contains the source control parameters", "required": true, "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$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" }, @@ -9633,20 +10097,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteAuthSettings" + "$ref": "#/definitions/SiteSourceControl" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": { "post": { "tags": [ "Sites" ], - "summary": "Gets the web app publishing credentials", - "operationId": "Sites_ListSitePublishingCredentials", + "summary": "Gets the application settings of web app", + "operationId": "Sites_ListSiteAppSettings", "consumes": [], "produces": [ "application/json", @@ -9680,21 +10144,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/User" + "$ref": "#/definitions/StringDictionary" } } }, - "deprecated": false, - "x-ms-long-running-operation": true + "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": { "post": { "tags": [ "Sites" ], - "summary": "Gets the web app publishing credentials", - "operationId": "Sites_ListSitePublishingCredentialsSlot", + "summary": "Gets the application settings of web app", + "operationId": "Sites_ListSiteAppSettingsSlot", "consumes": [], "produces": [ "application/json", @@ -9735,22 +10198,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/User" + "$ref": "#/definitions/StringDictionary" } } }, - "deprecated": false, - "x-ms-long-running-operation": true + "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings": { + "put": { "tags": [ "Sites" ], - "summary": "Gets the web app meta data.", - "operationId": "Sites_ListSiteMetadata", - "consumes": [], + "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", @@ -9772,6 +10238,15 @@ "required": true, "type": "string" }, + { + "name": "appSettings", + "in": "body", + "description": "Application settings of web app", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -9790,14 +10265,18 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": { + "put": { "tags": [ "Sites" ], - "summary": "Gets the web app meta data.", - "operationId": "Sites_ListSiteMetadataSlot", - "consumes": [], + "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", @@ -9819,6 +10298,15 @@ "required": true, "type": "string" }, + { + "name": "appSettings", + "in": "body", + "description": "Application settings of web app", + "required": true, + "schema": { + "$ref": "#/definitions/StringDictionary" + } + }, { "name": "slot", "in": "path", @@ -9844,18 +10332,14 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": { + "post": { "tags": [ "Sites" ], - "summary": "Updates the meta data for web app", - "operationId": "Sites_UpdateSiteMetadataSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets the connection strings associated with web app", + "operationId": "Sites_ListSiteConnectionStrings", + "consumes": [], "produces": [ "application/json", "text/json", @@ -9877,22 +10361,6 @@ "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" }, @@ -9904,25 +10372,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/ConnectionStringDictionary" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": { + "post": { "tags": [ "Sites" ], - "summary": "Updates the meta data for web app", - "operationId": "Sites_UpdateSiteMetadata", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets the connection strings associated with web app", + "operationId": "Sites_ListSiteConnectionStringsSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -9945,13 +10409,11 @@ "type": "string" }, { - "name": "metadata", - "in": "body", - "description": "Meta data of web app", + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, - "schema": { - "$ref": "#/definitions/StringDictionary" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -9964,21 +10426,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/StringDictionary" + "$ref": "#/definitions/ConnectionStringDictionary" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": { + "put": { "tags": [ "Sites" ], - "summary": "Gets the web app logs configuration", - "operationId": "Sites_GetSiteLogsConfig", - "consumes": [], + "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", @@ -10000,6 +10466,15 @@ "required": true, "type": "string" }, + { + "name": "connectionStrings", + "in": "body", + "description": "Connection strings associated with web app", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionStringDictionary" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -10011,18 +10486,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/ConnectionStringDictionary" } } }, "deprecated": false - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": { "put": { "tags": [ "Sites" ], - "summary": "Updates the meta data for web app", - "operationId": "Sites_UpdateSiteLogsConfig", + "summary": "Updates the connection strings associated with web app", + "operationId": "Sites_UpdateSiteConnectionStringsSlot", "consumes": [ "application/json", "text/json", @@ -10050,14 +10527,21 @@ "type": "string" }, { - "name": "siteLogsConfig", + "name": "connectionStrings", "in": "body", - "description": "Site logs configuration", + "description": "Connection strings associated with web app", "required": true, "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$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" }, @@ -10069,20 +10553,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/ConnectionStringDictionary" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": { + "post": { "tags": [ "Sites" ], - "summary": "Gets the web app logs configuration", - "operationId": "Sites_GetSiteLogsConfigSlot", + "summary": "Gets the Authentication / Authorization settings associated with web app", + "operationId": "Sites_ListSiteAuthSettings", "consumes": [], "produces": [ "application/json", @@ -10105,13 +10589,6 @@ "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" }, @@ -10123,23 +10600,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/SiteAuthSettings" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": { + "post": { "tags": [ "Sites" ], - "summary": "Updates the meta data for web app", - "operationId": "Sites_UpdateSiteLogsConfigSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets the Authentication / Authorization settings associated with web app", + "operationId": "Sites_ListSiteAuthSettingsSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -10161,15 +10636,6 @@ "required": true, "type": "string" }, - { - "name": "siteLogsConfig", - "in": "body", - "description": "Site logs configuration", - "required": true, - "schema": { - "$ref": "#/definitions/SiteLogsConfig" - } - }, { "name": "slot", "in": "path", @@ -10188,20 +10654,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/SiteLogsConfig" + "$ref": "#/definitions/SiteAuthSettings" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": { + "put": { "tags": [ "Sites" ], - "operationId": "Sites_ListSitePremierAddOns", - "consumes": [], + "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", @@ -10212,15 +10683,26 @@ { "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" }, @@ -10232,20 +10714,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/SiteAuthSettings" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": { + "put": { "tags": [ "Sites" ], - "operationId": "Sites_ListSitePremierAddOnsSlot", - "consumes": [], + "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", @@ -10256,18 +10743,30 @@ { "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" }, @@ -10282,19 +10781,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/SiteAuthSettings" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list": { + "post": { "tags": [ "Sites" ], - "operationId": "Sites_GetSitePremierAddOn", + "summary": "Gets the web app publishing credentials", + "operationId": "Sites_ListSitePublishingCredentials", "consumes": [], "produces": [ "application/json", @@ -10306,18 +10806,14 @@ { "name": "resourceGroupName", "in": "path", + "description": "Name of resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", + "description": "Name of web app", "required": true, "type": "string" }, @@ -10332,22 +10828,22 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/User" } } }, - "deprecated": false - }, - "put": { + "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" ], - "operationId": "Sites_AddSitePremierAddOn", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets the web app publishing credentials", + "operationId": "Sites_ListSitePublishingCredentialsSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -10358,29 +10854,24 @@ { "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": "premierAddOnName", + "name": "slot", "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, - { - "name": "premierAddOn", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PremierAddOnRequest" - } - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -10392,17 +10883,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/User" } } }, - "deprecated": false - }, - "delete": { + "deprecated": false, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": { + "post": { "tags": [ "Sites" ], - "operationId": "Sites_DeleteSitePremierAddOn", + "summary": "Gets the web app meta data.", + "operationId": "Sites_ListSiteMetadata", "consumes": [], "produces": [ "application/json", @@ -10414,18 +10909,14 @@ { "name": "resourceGroupName", "in": "path", + "description": "Name of resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "in": "path", + "description": "Name of web app", "required": true, "type": "string" }, @@ -10440,19 +10931,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/StringDictionary" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": { + "post": { "tags": [ "Sites" ], - "operationId": "Sites_GetSitePremierAddOnSlot", + "summary": "Gets the web app meta data.", + "operationId": "Sites_ListSiteMetadataSlot", "consumes": [], "produces": [ "application/json", @@ -10464,24 +10956,21 @@ { "name": "resourceGroupName", "in": "path", + "description": "Name of resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOnName", - "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" }, @@ -10496,17 +10985,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/StringDictionary" } } }, "deprecated": false - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": { "put": { "tags": [ "Sites" ], - "operationId": "Sites_AddSitePremierAddOnSlot", + "summary": "Updates the meta data for web app", + "operationId": "Sites_UpdateSiteMetadata", "consumes": [ "application/json", "text/json", @@ -10522,35 +11014,26 @@ { "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": "premierAddOnName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "premierAddOn", + "name": "metadata", "in": "body", + "description": "Meta data of web app", "required": true, "schema": { - "$ref": "#/definitions/PremierAddOnRequest" + "$ref": "#/definitions/StringDictionary" } }, - { - "name": "slot", - "in": "path", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -10562,18 +11045,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/StringDictionary" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": { + "put": { "tags": [ "Sites" ], - "operationId": "Sites_DeleteSitePremierAddOnSlot", - "consumes": [], + "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", @@ -10584,24 +11074,30 @@ { "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": "premierAddOnName", - "in": "path", + "name": "metadata", + "in": "body", + "description": "Meta data of web app", "required": true, - "type": "string" + "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" }, @@ -10616,20 +11112,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/StringDictionary" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": { + "get": { "tags": [ "Sites" ], - "summary": "Gets the backup configuration for a web app", - "operationId": "Sites_GetSiteBackupConfigurationSlot", + "summary": "Gets the web app logs configuration", + "operationId": "Sites_GetSiteLogsConfig", "consumes": [], "produces": [ "application/json", @@ -10652,13 +11148,6 @@ "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" }, @@ -10670,21 +11159,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteLogsConfig" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": { - "post": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Gets the backup configuration for a web app", - "operationId": "Sites_GetSiteBackupConfiguration", - "consumes": [], + "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", @@ -10706,6 +11197,15 @@ "required": true, "type": "string" }, + { + "name": "siteLogsConfig", + "in": "body", + "description": "Site logs configuration", + "required": true, + "schema": { + "$ref": "#/definitions/SiteLogsConfig" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -10717,25 +11217,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteLogsConfig" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": { + "get": { "tags": [ "Sites" ], - "summary": "Updates backup configuration of web app", - "operationId": "Sites_UpdateSiteBackupConfiguration", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets the web app logs configuration", + "operationId": "Sites_GetSiteLogsConfigSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -10757,15 +11253,13 @@ "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" }, @@ -10777,20 +11271,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteLogsConfig" } } }, "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", + "summary": "Updates the meta data for web app", + "operationId": "Sites_UpdateSiteLogsConfigSlot", "consumes": [ "application/json", "text/json", @@ -10818,12 +11310,12 @@ "type": "string" }, { - "name": "request", + "name": "siteLogsConfig", "in": "body", - "description": "Information on backup request", + "description": "Site logs configuration", "required": true, "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteLogsConfig" } }, { @@ -10844,25 +11336,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/SiteLogsConfig" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": { + "get": { "tags": [ "Sites" ], - "summary": "Creates web app backup", - "operationId": "Sites_BackupSiteDeprecated", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "operationId": "Sites_ListSitePremierAddOnsSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -10873,25 +11360,20 @@ { "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", + "name": "slot", + "in": "path", "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -10904,23 +11386,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/Object" } } }, "deprecated": false - }, - "post": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": { + "get": { "tags": [ "Sites" ], - "summary": "Creates web app backup", - "operationId": "Sites_BackupSite", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "operationId": "Sites_ListSitePremierAddOns", + "consumes": [], "produces": [ "application/json", "text/json", @@ -10931,26 +11410,15 @@ { "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" }, @@ -10962,25 +11430,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": { + "get": { "tags": [ "Sites" ], - "summary": "Creates web app backup", - "operationId": "Sites_BackupSiteDeprecatedSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "operationId": "Sites_GetSitePremierAddOn", + "consumes": [], "produces": [ "application/json", "text/json", @@ -10991,30 +11454,18 @@ { "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", + "name": "premierAddOnName", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -11029,18 +11480,17 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/Object" } } }, "deprecated": false }, - "post": { + "put": { "tags": [ "Sites" ], - "summary": "Creates web app backup", - "operationId": "Sites_BackupSiteSlot", + "operationId": "Sites_AddSitePremierAddOn", "consumes": [ "application/json", "text/json", @@ -11056,32 +11506,28 @@ { "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", + "name": "premierAddOnName", + "in": "path", "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } + "type": "string" }, { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "name": "premierAddOn", + "in": "body", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/PremierAddOnRequest" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -11094,25 +11540,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/Object" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover": { - "put": { + }, + "delete": { "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" - ], + "operationId": "Sites_DeleteSitePremierAddOn", + "consumes": [], "produces": [ "application/json", "text/json", @@ -11123,30 +11562,18 @@ { "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", + "name": "premierAddOnName", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -11161,25 +11588,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": { + "get": { "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" - ], + "operationId": "Sites_GetSitePremierAddOnSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -11190,25 +11612,26 @@ { "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", + "name": "premierAddOnName", + "in": "path", "required": true, - "schema": { - "$ref": "#/definitions/RestoreRequest" - } + "type": "string" + }, + { + "name": "slot", + "in": "path", + "required": true, + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -11221,37 +11644,58 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/Object" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": { - "get": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Lists all available backups for web app", - "operationId": "Sites_ListSiteBackups", - "consumes": [], + "operationId": "Sites_AddSitePremierAddOnSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", - "text/json" + "text/json", + "application/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": "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" }, @@ -11266,44 +11710,46 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItemCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { - "get": { + }, + "delete": { "tags": [ "Sites" ], - "summary": "Lists all available backups for web app", - "operationId": "Sites_ListSiteBackupsSlot", + "operationId": "Sites_DeleteSitePremierAddOnSlot", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/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": "premierAddOnName", + "in": "path", "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" }, @@ -11318,20 +11764,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItemCollection" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": { + "post": { "tags": [ "Sites" ], - "summary": "Gets status of a web app backup that may be in progress.", - "operationId": "Sites_GetSiteBackupStatusSlot", + "summary": "Gets the backup configuration for a web app", + "operationId": "Sites_GetSiteBackupConfiguration", "consumes": [], "produces": [ "application/json", @@ -11354,20 +11800,6 @@ "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" }, @@ -11379,18 +11811,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": { + "post": { "tags": [ "Sites" ], - "summary": "Deletes a backup from Azure Storage", - "operationId": "Sites_DeleteBackupSlot", + "summary": "Gets the backup configuration for a web app", + "operationId": "Sites_GetSiteBackupConfigurationSlot", "consumes": [], "produces": [ "application/json", @@ -11413,13 +11847,6 @@ "required": true, "type": "string" }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, { "name": "slot", "in": "path", @@ -11438,21 +11865,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": { + "put": { "tags": [ "Sites" ], - "summary": "Gets status of a web app backup that may be in progress.", - "operationId": "Sites_GetSiteBackupStatus", - "consumes": [], + "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", @@ -11475,9 +11906,18 @@ "type": "string" }, { - "name": "backupId", + "name": "request", + "in": "body", + "description": "Information on backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, + { + "name": "slot", "in": "path", - "description": "Id of backup", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -11492,19 +11932,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": { + "put": { "tags": [ "Sites" ], - "summary": "Deletes a backup from Azure Storage", - "operationId": "Sites_DeleteBackup", - "consumes": [], + "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", @@ -11527,11 +11973,13 @@ "type": "string" }, { - "name": "backupId", - "in": "path", - "description": "Id of backup", + "name": "request", + "in": "body", + "description": "Information on backup request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/BackupRequest" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -11544,20 +11992,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItem" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": { + "put": { "tags": [ "Sites" ], - "summary": "Gets status of a web app backup that may be in progress, including secrets\r\n associated with the backup, such as the Azure Storage SAS URL. Also can be\r\n used to update the SAS URL for the backup if a new URL is passed in the\r\n request body.", - "operationId": "Sites_GetSiteBackupStatusSecrets", + "summary": "Creates web app backup", + "operationId": "Sites_BackupSiteDeprecated", "consumes": [ "application/json", "text/json", @@ -11584,13 +12032,6 @@ "required": true, "type": "string" }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, { "name": "request", "in": "body", @@ -11616,15 +12057,13 @@ } }, "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\r\n associated with the backup, such as the Azure Storage SAS URL. Also can be\r\n used to update the SAS URL for the backup if a new URL is passed in the\r\n request body.", - "operationId": "Sites_GetSiteBackupStatusSecretsSlot", + "summary": "Creates web app backup", + "operationId": "Sites_BackupSite", "consumes": [ "application/json", "text/json", @@ -11651,13 +12090,6 @@ "required": true, "type": "string" }, - { - "name": "backupId", - "in": "path", - "description": "Id of backup", - "required": true, - "type": "string" - }, { "name": "request", "in": "body", @@ -11667,13 +12099,6 @@ "$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" }, @@ -11692,13 +12117,13 @@ "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": { + "put": { "tags": [ "Sites" ], - "summary": "Restores a web app", - "operationId": "Sites_RestoreSiteSlot", + "summary": "Creates web app backup", + "operationId": "Sites_BackupSiteDeprecatedSlot", "consumes": [ "application/json", "text/json", @@ -11725,20 +12150,13 @@ "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", + "description": "Information on backup request", "required": true, "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/BackupRequest" } }, { @@ -11759,20 +12177,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RestoreResponse" + "$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", + "summary": "Creates web app backup", + "operationId": "Sites_BackupSiteSlot", "consumes": [ "application/json", "text/json", @@ -11799,22 +12215,22 @@ "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", + "description": "Information on backup request", "required": true, "schema": { - "$ref": "#/definitions/RestoreRequest" + "$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" }, @@ -11826,21 +12242,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RestoreResponse" + "$ref": "#/definitions/BackupItem" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup/config": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover": { + "put": { "tags": [ "Sites" ], - "summary": "Gets the backup configuration for a web app", - "operationId": "Sites_GetSiteBackupConfigurationDeprecated", - "consumes": [], + "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", @@ -11862,6 +12282,15 @@ "required": true, "type": "string" }, + { + "name": "request", + "in": "body", + "description": "Information on restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -11873,18 +12302,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/RestoreRequest" } } }, "deprecated": false - }, + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover": { "put": { "tags": [ "Sites" ], - "summary": "Updates backup configuration of web app", - "operationId": "Sites_UpdateSiteBackupConfigurationDeprecated", + "summary": "Discovers existing web app backups that can be restored", + "operationId": "Sites_DiscoverSiteRestoreSlot", "consumes": [ "application/json", "text/json", @@ -11914,12 +12345,19 @@ { "name": "request", "in": "body", - "description": "Information on backup request", + "description": "Information on restore request", "required": true, "schema": { - "$ref": "#/definitions/BackupRequest" + "$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" }, @@ -11931,24 +12369,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/RestoreRequest" } } }, "deprecated": false - }, - "post": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": { + "get": { "tags": [ "Sites" ], - "summary": "Lists all backup configurations for a web app", - "operationId": "Sites_ListSiteBackupConfigurationDeprecated", + "summary": "Lists all available backups for web app", + "operationId": "Sites_ListSiteBackups", "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" + "produces": [ + "application/json", + "text/json" ], "parameters": [ { @@ -11976,26 +12414,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/BackupItemCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup/config": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": { "get": { "tags": [ "Sites" ], - "summary": "Gets the backup configuration for a web app", - "operationId": "Sites_GetSiteBackupConfigurationDeprecatedSlot", + "summary": "Lists all available backups for web app", + "operationId": "Sites_ListSiteBackupsSlot", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -12030,23 +12466,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/BackupItemCollection" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": { + "get": { "tags": [ "Sites" ], - "summary": "Updates backup configuration of web app", - "operationId": "Sites_UpdateSiteBackupConfigurationDeprecatedSlot", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Gets status of a web app backup that may be in progress.", + "operationId": "Sites_GetSiteBackupStatus", + "consumes": [], "produces": [ "application/json", "text/json", @@ -12069,18 +12503,9 @@ "type": "string" }, { - "name": "request", - "in": "body", - "description": "Information on backup request", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - }, - { - "name": "slot", + "name": "backupId", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Id of backup", "required": true, "type": "string" }, @@ -12095,18 +12520,18 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/BackupItem" } } }, "deprecated": false }, - "post": { + "delete": { "tags": [ "Sites" ], - "summary": "Lists all backup configurations for a web app", - "operationId": "Sites_ListSiteBackupConfigurationDeprecatedSlot", + "summary": "Deletes a backup from Azure Storage", + "operationId": "Sites_DeleteBackup", "consumes": [], "produces": [ "application/json", @@ -12130,9 +12555,9 @@ "type": "string" }, { - "name": "slot", + "name": "backupId", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Id of backup", "required": true, "type": "string" }, @@ -12147,24 +12572,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupRequest" + "$ref": "#/definitions/BackupItem" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restore": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": { "get": { "tags": [ "Sites" ], - "summary": "Lists all available backups for web app", - "operationId": "Sites_ListSiteBackupsDeprecated", + "summary": "Gets status of a web app backup that may be in progress.", + "operationId": "Sites_GetSiteBackupStatusSlot", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -12181,6 +12608,20 @@ "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" }, @@ -12192,24 +12633,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItemCollection" + "$ref": "#/definitions/BackupItem" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restore": { - "get": { + }, + "delete": { "tags": [ "Sites" ], - "summary": "Lists all available backups for web app", - "operationId": "Sites_ListSiteBackupsDeprecatedSlot", + "summary": "Deletes a backup from Azure Storage", + "operationId": "Sites_DeleteBackupSlot", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -12226,6 +12667,13 @@ "required": true, "type": "string" }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, { "name": "slot", "in": "path", @@ -12244,20 +12692,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/BackupItemCollection" + "$ref": "#/definitions/BackupItem" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restore/discover": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": { + "post": { "tags": [ "Sites" ], - "summary": "Discovers existing web app backups that can be restored", - "operationId": "Sites_DiscoverSiteRestoreDeprecated", + "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", @@ -12284,13 +12732,20 @@ "required": true, "type": "string" }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, { "name": "request", "in": "body", - "description": "Information on restore request", + "description": "Information on backup request", "required": true, "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/BackupRequest" } }, { @@ -12304,20 +12759,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/BackupItem" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restore/discover": { - "put": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": { + "post": { "tags": [ "Sites" ], - "summary": "Discovers existing web app backups that can be restored", - "operationId": "Sites_DiscoverSiteRestoreDeprecatedSlot", + "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", @@ -12344,13 +12799,20 @@ "required": true, "type": "string" }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup", + "required": true, + "type": "string" + }, { "name": "request", "in": "body", - "description": "Information on restore request", + "description": "Information on backup request", "required": true, "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/BackupRequest" } }, { @@ -12371,75 +12833,30 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RestoreRequest" + "$ref": "#/definitions/BackupItem" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore": { + "post": { "tags": [ "Sites" ], - "summary": "Gets the quota usage numbers for web app", - "operationId": "Sites_GetSiteUsages", - "consumes": [], - "produces": [ + "summary": "Restores a web app", + "operationId": "Sites_RestoreSite", + "consumes": [ "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" + "text/json", + "application/x-www-form-urlencoded" ], - "summary": "Gets the quota usage numbers for web app", - "operationId": "Sites_GetSiteUsagesSlot", - "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -12457,17 +12874,20 @@ "type": "string" }, { - "name": "slot", + "name": "backupId", "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "description": "Id of backup to restore", "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" + "name": "request", + "in": "body", + "description": "Information on restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -12480,24 +12900,30 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/CsmUsageQuotaCollection" + "$ref": "#/definitions/RestoreResponse" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": { + "post": { "tags": [ "Sites" ], - "summary": "Gets metrics for web app", - "operationId": "Sites_GetSiteMetrics", - "consumes": [], + "summary": "Restores a web app", + "operationId": "Sites_RestoreSiteSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -12510,20 +12936,31 @@ { "name": "name", "in": "path", - "description": "Name of web app", + "description": "Name of web app", + "required": true, + "type": "string" + }, + { + "name": "backupId", + "in": "path", + "description": "Id of backup to restore", "required": true, "type": "string" }, { - "name": "details", - "in": "query", - "description": "If true, metric details are included in response", - "type": "boolean" + "name": "request", + "in": "body", + "description": "Information on restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } }, { - "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]'.", + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", + "required": true, "type": "string" }, { @@ -12537,24 +12974,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResourceMetricCollection" + "$ref": "#/definitions/RestoreResponse" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup/config": { "get": { "tags": [ "Sites" ], - "summary": "Gets metrics for web app", - "operationId": "Sites_GetSiteMetricsSlot", + "summary": "Gets the backup configuration for a web app", + "operationId": "Sites_GetSiteBackupConfigurationDeprecated", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -12571,25 +13010,6 @@ "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" }, @@ -12601,24 +13021,28 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ResourceMetricCollection" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { - "get": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Gets metric definitions for web app", - "operationId": "Sites_GetSiteMetricDefinitions", - "consumes": [], + "summary": "Updates backup configuration of web app", + "operationId": "Sites_UpdateSiteBackupConfigurationDeprecated", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -12635,6 +13059,15 @@ "required": true, "type": "string" }, + { + "name": "request", + "in": "body", + "description": "Information on backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -12646,24 +13079,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions": { - "get": { + }, + "post": { "tags": [ "Sites" ], - "summary": "Gets metric definitions for web app", - "operationId": "Sites_GetSiteMetricDefinitionsSlot", + "summary": "Lists all backup configurations for a web app", + "operationId": "Sites_ListSiteBackupConfigurationDeprecated", "consumes": [], "produces": [ "application/json", - "text/json" + "text/json", + "application/xml", + "text/xml" ], "parameters": [ { @@ -12680,13 +13113,6 @@ "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" }, @@ -12698,27 +13124,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/MetricDefinitionCollection" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup/config": { + "get": { "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" - ], + "summary": "Gets the backup configuration for a web app", + "operationId": "Sites_GetSiteBackupConfigurationDeprecatedSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -12741,13 +13161,11 @@ "type": "string" }, { - "name": "options", - "in": "body", - "description": "Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format.", + "name": "slot", + "in": "path", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, - "schema": { - "$ref": "#/definitions/CsmPublishingProfileOptions" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -12760,25 +13178,21 @@ "200": { "description": "OK", "schema": { - "type": "file" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": { - "post": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Gets the publishing profile for web app", - "operationId": "Sites_ListSitePublishingProfileXmlSlot", + "summary": "Updates backup configuration of web app", + "operationId": "Sites_UpdateSiteBackupConfigurationDeprecatedSlot", "consumes": [ "application/json", "text/json", - "application/xml", - "text/xml", "application/x-www-form-urlencoded" ], "produces": [ @@ -12803,12 +13217,12 @@ "type": "string" }, { - "name": "options", + "name": "request", "in": "body", - "description": "Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format.", + "description": "Information on backup request", "required": true, "schema": { - "$ref": "#/definitions/CsmPublishingProfileOptions" + "$ref": "#/definitions/BackupRequest" } }, { @@ -12829,20 +13243,18 @@ "200": { "description": "OK", "schema": { - "type": "file" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { + }, "post": { "tags": [ "Sites" ], - "summary": "Restarts web app", - "operationId": "Sites_RestartSite", + "summary": "Lists all backup configurations for a web app", + "operationId": "Sites_ListSiteBackupConfigurationDeprecatedSlot", "consumes": [], "produces": [ "application/json", @@ -12866,16 +13278,11 @@ "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" + "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" @@ -12888,26 +13295,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/BackupRequest" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restore": { + "get": { "tags": [ "Sites" ], - "summary": "Restarts web app", - "operationId": "Sites_RestartSiteSlot", + "summary": "Lists all available backups for web app", + "operationId": "Sites_ListSiteBackupsDeprecatedSlot", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -12931,18 +13336,6 @@ "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" }, @@ -12954,26 +13347,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/BackupItemCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restore": { + "get": { "tags": [ "Sites" ], - "summary": "Starts web app", - "operationId": "Sites_StartSite", + "summary": "Lists all available backups for web app", + "operationId": "Sites_ListSiteBackupsDeprecated", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -13001,21 +13392,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/BackupItemCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restore/discover": { + "put": { "tags": [ "Sites" ], - "summary": "Starts web app", - "operationId": "Sites_StartSiteSlot", - "consumes": [], + "summary": "Discovers existing web app backups that can be restored", + "operationId": "Sites_DiscoverSiteRestoreDeprecated", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -13038,11 +13433,13 @@ "type": "string" }, { - "name": "slot", - "in": "path", - "description": "Name of web app slot. If not specified then will default to production slot.", + "name": "request", + "in": "body", + "description": "Information on restore request", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/RestoreRequest" + } }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -13055,21 +13452,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/RestoreRequest" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restore/discover": { + "put": { "tags": [ "Sites" ], - "summary": "Stops web app", - "operationId": "Sites_StopSiteSlot", - "consumes": [], + "summary": "Discovers existing web app backups that can be restored", + "operationId": "Sites_DiscoverSiteRestoreDeprecatedSlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -13091,6 +13492,15 @@ "required": true, "type": "string" }, + { + "name": "request", + "in": "body", + "description": "Information on restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequest" + } + }, { "name": "slot", "in": "path", @@ -13109,26 +13519,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/RestoreRequest" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": { + "get": { "tags": [ "Sites" ], - "summary": "Stops web app", - "operationId": "Sites_StopSite", + "summary": "Gets the quota usage numbers for web app", + "operationId": "Sites_GetSiteUsages", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -13145,6 +13553,12 @@ "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" }, @@ -13156,39 +13570,53 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/CsmUsageQuotaCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": { + "get": { "tags": [ "Sites" ], - "operationId": "Sites_SyncSiteRepository", + "summary": "Gets the quota usage numbers for web app", + "operationId": "Sites_GetSiteUsagesSlot", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "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" }, @@ -13200,43 +13628,50 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/CsmUsageQuotaCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics": { + "get": { "tags": [ "Sites" ], - "operationId": "Sites_SyncSiteRepositorySlot", + "summary": "Gets metrics for web app", + "operationId": "Sites_GetSiteMetrics", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "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", - "required": true, + "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" }, { @@ -13250,26 +13685,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/ResourceMetricCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics": { + "get": { "tags": [ "Sites" ], - "summary": "Generates new random app publishing password", - "operationId": "Sites_GenerateNewSitePublishingPasswordSlot", + "summary": "Gets metrics for web app", + "operationId": "Sites_GetSiteMetricsSlot", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -13293,6 +13726,18 @@ "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" }, @@ -13304,26 +13749,24 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/ResourceMetricCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions": { + "get": { "tags": [ "Sites" ], - "summary": "Generates new random app publishing password", - "operationId": "Sites_GenerateNewSitePublishingPassword", + "summary": "Gets metric definitions for web app", + "operationId": "Sites_GetSiteMetricDefinitionsSlot", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { @@ -13340,6 +13783,13 @@ "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" }, @@ -13351,46 +13801,37 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/MetricDefinitionCollection" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions": { "get": { "tags": [ "Sites" ], - "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", - "operationId": "Sites_GetSiteRelayServiceConnection", + "summary": "Gets metric definitions for web app", + "operationId": "Sites_GetSiteMetricDefinitions", "consumes": [], "produces": [ "application/json", - "text/json", - "application/xml", - "text/xml" + "text/json" ], "parameters": [ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "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", + "description": "Name of web app", "required": true, "type": "string" }, @@ -13405,21 +13846,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/MetricDefinitionCollection" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": { + "post": { "tags": [ "Sites" ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", - "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnection", + "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": [ @@ -13432,31 +13877,24 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "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", + "description": "Name of web app", "required": true, "type": "string" }, { - "name": "connectionEnvelope", + "name": "options", "in": "body", - "description": "The details of the Hybrid Connection", + "description": "Specifies options for publishing profile. Pass CsmPublishingProfileOptions.Format=FileZilla3 for FileZilla FTP format.", "required": true, "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/CsmPublishingProfileOptions" } }, { @@ -13470,19 +13908,27 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "type": "file" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": { + "post": { "tags": [ "Sites" ], - "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", - "operationId": "Sites_DeleteSiteRelayServiceConnection", - "consumes": [], + "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", @@ -13493,21 +13939,30 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "Name of web app", "required": true, "type": "string" }, { - "name": "entityName", + "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": "The name by which the Hybrid Connection is identified", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -13522,23 +13977,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "type": "file" } } }, "deprecated": false - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": { + "post": { "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" - ], + "summary": "Restarts web app", + "operationId": "Sites_RestartSiteSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -13549,32 +14002,35 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "Name of web app", "required": true, "type": "string" }, { - "name": "entityName", + "name": "slot", "in": "path", - "description": "The name by which the Hybrid Connection is identified", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "The details of the Hybrid Connection", - "required": true, - "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" - } + "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" @@ -13587,20 +14043,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": { + "post": { "tags": [ "Sites" ], - "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", - "operationId": "Sites_GetSiteRelayServiceConnectionSlot", + "summary": "Restarts web app", + "operationId": "Sites_RestartSite", "consumes": [], "produces": [ "application/json", @@ -13612,30 +14068,28 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "The name of the web app", + "description": "Name of 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": "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": "slot", - "in": "path", - "description": "The name of the slot for the web app.", - "required": true, - "type": "string" + "name": "synchronous", + "in": "query", + "description": "If true then the API will block until the app has been restarted", + "type": "boolean" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -13648,23 +14102,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/Object" } } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": { + "post": { "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" - ], + "summary": "Starts web app", + "operationId": "Sites_StartSite", + "consumes": [], "produces": [ "application/json", "text/json", @@ -13675,37 +14127,14 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "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.", + "description": "Name of web app", "required": true, "type": "string" }, @@ -13720,18 +14149,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/Object" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": { + "post": { "tags": [ "Sites" ], - "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", - "operationId": "Sites_DeleteSiteRelayServiceConnectionSlot", + "summary": "Starts web app", + "operationId": "Sites_StartSiteSlot", "consumes": [], "produces": [ "application/json", @@ -13743,28 +14174,21 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "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", + "description": "Name of web app", "required": true, "type": "string" }, { "name": "slot", "in": "path", - "description": "The name of the slot for the web app.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, "type": "string" }, @@ -13784,18 +14208,16 @@ } }, "deprecated": false - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": { + "post": { "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" - ], + "summary": "Stops web app", + "operationId": "Sites_StopSite", + "consumes": [], "produces": [ "application/json", "text/json", @@ -13806,37 +14228,14 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "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.", + "description": "Name of web app", "required": true, "type": "string" }, @@ -13851,20 +14250,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": { + "post": { "tags": [ "Sites" ], - "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", - "operationId": "Sites_ListSiteRelayServiceConnections", + "summary": "Stops web app", + "operationId": "Sites_StopSiteSlot", "consumes": [], "produces": [ "application/json", @@ -13876,14 +14275,21 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "required": true, "type": "string" }, { "name": "name", "in": "path", - "description": "The name of the web app", + "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" }, @@ -13898,20 +14304,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": { + "post": { "tags": [ "Sites" ], - "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", - "operationId": "Sites_ListSiteRelayServiceConnectionsSlot", + "operationId": "Sites_SyncSiteRepositorySlot", "consumes": [], "produces": [ "application/json", @@ -13923,21 +14328,18 @@ { "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" }, @@ -13952,20 +14354,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RelayServiceConnectionEntity" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": { + "post": { "tags": [ "Sites" ], - "summary": "Retrieves a Virtual Network connection gateway associated with this web app and virtual network.", - "operationId": "Sites_GetSiteVnetGateway", + "operationId": "Sites_SyncSiteRepository", "consumes": [], "produces": [ "application/json", @@ -13977,28 +14378,12 @@ { "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" }, @@ -14015,24 +14400,19 @@ "schema": { "$ref": "#/definitions/Object" } - }, - "404": { - "description": "Gateway does not exist. Only the \"primary\" gateway exists presently." } }, "deprecated": false - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { + "post": { "tags": [ "Sites" ], - "summary": "Updates the Virtual Network Gateway.", - "operationId": "Sites_CreateOrUpdateSiteVNETConnectionGateway", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Generates new random app publishing password", + "operationId": "Sites_GenerateNewSitePublishingPasswordSlot", + "consumes": [], "produces": [ "application/json", "text/json", @@ -14043,39 +14423,23 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "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", + "description": "Name of web app", "required": true, "type": "string" }, { - "name": "gatewayName", + "name": "slot", "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.", + "description": "Name of web app slot. If not specified then will default to production slot.", "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } + "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" @@ -14088,23 +14452,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/Object" } } }, "deprecated": false - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { + "post": { "tags": [ "Sites" ], - "summary": "Updates the Virtual Network Gateway.", - "operationId": "Sites_UpdateSiteVNETConnectionGateway", - "consumes": [ - "application/json", - "text/json", - "application/x-www-form-urlencoded" - ], + "summary": "Generates new random app publishing password", + "operationId": "Sites_GenerateNewSitePublishingPassword", + "consumes": [], "produces": [ "application/json", "text/json", @@ -14115,40 +14477,17 @@ { "name": "resourceGroupName", "in": "path", - "description": "The resource group name", + "description": "Name of resource group", "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\"", + "description": "Name of web app", "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" }, @@ -14160,20 +14499,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/Object" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": { "get": { "tags": [ "Sites" ], - "summary": "Retrieves a Virtual Network connection gateway associated with this web app and virtual network.", - "operationId": "Sites_GetSiteVnetGatewaySlot", + "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", + "operationId": "Sites_GetSiteRelayServiceConnection", "consumes": [], "produces": [ "application/json", @@ -14197,23 +14536,9 @@ "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", + "name": "entityName", "in": "path", - "description": "The name of the slot for this web app.", + "description": "The name by which the Hybrid Connection is identified", "required": true, "type": "string" }, @@ -14228,11 +14553,8 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "$ref": "#/definitions/RelayServiceConnectionEntity" } - }, - "404": { - "description": "Gateway does not exist. Only the \"primary\" gateway exists presently." } }, "deprecated": false @@ -14241,8 +14563,8 @@ "tags": [ "Sites" ], - "summary": "Updates the Virtual Network Gateway.", - "operationId": "Sites_CreateOrUpdateSiteVNETConnectionGatewaySlot", + "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnection", "consumes": [ "application/json", "text/json", @@ -14270,32 +14592,70 @@ "type": "string" }, { - "name": "vnetName", + "name": "entityName", "in": "path", - "description": "The name of the Virtual Network", + "description": "The name by which the Hybrid Connection is identified", "required": true, "type": "string" }, { - "name": "gatewayName", + "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 name of the gateway. The only gateway that exists presently is \"primary\"", + "description": "The resource group name", "required": true, "type": "string" }, { - "name": "connectionEnvelope", - "in": "body", - "description": "The properties to update this gateway with.", + "name": "name", + "in": "path", + "description": "The name of the web app", "required": true, - "schema": { - "$ref": "#/definitions/VnetGateway" - } + "type": "string" }, { - "name": "slot", + "name": "entityName", "in": "path", - "description": "The name of the slot for this web app.", + "description": "The name by which the Hybrid Connection is identified", "required": true, "type": "string" }, @@ -14310,7 +14670,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/Object" } } }, @@ -14320,8 +14680,8 @@ "tags": [ "Sites" ], - "summary": "Updates the Virtual Network Gateway.", - "operationId": "Sites_UpdateSiteVNETConnectionGatewaySlot", + "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "operationId": "Sites_UpdateSiteRelayServiceConnection", "consumes": [ "application/json", "text/json", @@ -14349,35 +14709,21 @@ "type": "string" }, { - "name": "vnetName", - "in": "path", - "description": "The name of the Virtual Network", - "required": true, - "type": "string" - }, - { - "name": "gatewayName", + "name": "entityName", "in": "path", - "description": "The name of the gateway. The only gateway that exists presently is \"primary\"", + "description": "The name by which the Hybrid Connection is identified", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", - "description": "The properties to update this gateway with.", + "description": "The details of the Hybrid Connection", "required": true, "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/RelayServiceConnectionEntity" } }, - { - "name": "slot", - "in": "path", - "description": "The name of the slot for this web app.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -14389,20 +14735,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetGateway" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": { "get": { "tags": [ "Sites" ], - "summary": "Retrieves a specific Virtual Network Connection associated with this web app.", - "operationId": "Sites_GetSiteVNETConnectionSlot", + "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", + "operationId": "Sites_GetSiteRelayServiceConnectionSlot", "consumes": [], "produces": [ "application/json", @@ -14426,16 +14772,16 @@ "type": "string" }, { - "name": "vnetName", + "name": "entityName", "in": "path", - "description": "The name of the Virtual Network", + "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 this web app.", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -14450,7 +14796,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } }, @@ -14460,8 +14806,8 @@ "tags": [ "Sites" ], - "summary": "Adds a Virtual Network Connection or updates it's properties.", - "operationId": "Sites_CreateOrUpdateSiteVNETConnectionSlot", + "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnectionSlot", "consumes": [ "application/json", "text/json", @@ -14489,25 +14835,25 @@ "type": "string" }, { - "name": "vnetName", + "name": "entityName", "in": "path", - "description": "The name of the Virtual Network", + "description": "The name by which the Hybrid Connection is identified", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", - "description": "The properties of this Virtual Network Connection", + "description": "The details of the Hybrid Connection", "required": true, "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } }, { "name": "slot", "in": "path", - "description": "The name of the slot for this web app.", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -14522,7 +14868,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } }, @@ -14532,8 +14878,8 @@ "tags": [ "Sites" ], - "summary": "Removes the specified Virtual Network Connection association from this web app.", - "operationId": "Sites_DeleteSiteVNETConnectionSlot", + "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", + "operationId": "Sites_DeleteSiteRelayServiceConnectionSlot", "consumes": [], "produces": [ "application/json", @@ -14557,16 +14903,16 @@ "type": "string" }, { - "name": "vnetName", + "name": "entityName", "in": "path", - "description": "The name of the Virtual Network", + "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 this web app.", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -14591,8 +14937,8 @@ "tags": [ "Sites" ], - "summary": "Adds a Virtual Network Connection or updates it's properties.", - "operationId": "Sites_UpdateSiteVNETConnectionSlot", + "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "operationId": "Sites_UpdateSiteRelayServiceConnectionSlot", "consumes": [ "application/json", "text/json", @@ -14620,25 +14966,25 @@ "type": "string" }, { - "name": "vnetName", + "name": "entityName", "in": "path", - "description": "The name of the Virtual Network", + "description": "The name by which the Hybrid Connection is identified", "required": true, "type": "string" }, { "name": "connectionEnvelope", "in": "body", - "description": "The properties of this Virtual Network Connection", + "description": "The details of the Hybrid Connection", "required": true, "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } }, { "name": "slot", "in": "path", - "description": "The name of the slot for this web app.", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -14653,20 +14999,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": { "get": { "tags": [ "Sites" ], - "summary": "Retrieves a specific Virtual Network Connection associated with this web app.", - "operationId": "Sites_GetSiteVNETConnection", + "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", + "operationId": "Sites_ListSiteRelayServiceConnectionsSlot", "consumes": [], "produces": [ "application/json", @@ -14690,9 +15036,9 @@ "type": "string" }, { - "name": "vnetName", + "name": "slot", "in": "path", - "description": "The name of the Virtual Network", + "description": "The name of the slot for the web app.", "required": true, "type": "string" }, @@ -14707,23 +15053,21 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } }, "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" + } + }, + "/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", @@ -14745,22 +15089,6 @@ "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" }, @@ -14772,18 +15100,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/RelayServiceConnectionEntity" } } }, "deprecated": false - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { + "get": { "tags": [ "Sites" ], - "summary": "Removes the specified Virtual Network Connection association from this web app.", - "operationId": "Sites_DeleteSiteVNETConnection", + "summary": "Retrieves a Virtual Network connection gateway associated with this web app and virtual network.", + "operationId": "Sites_GetSiteVnetGatewaySlot", "consumes": [], "produces": [ "application/json", @@ -14813,6 +15143,20 @@ "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" }, @@ -14826,16 +15170,19 @@ "schema": { "$ref": "#/definitions/Object" } + }, + "404": { + "description": "Gateway does not exist. Only the \"primary\" gateway exists presently." } }, "deprecated": false }, - "patch": { + "put": { "tags": [ "Sites" ], - "summary": "Adds a Virtual Network Connection or updates it's properties.", - "operationId": "Sites_UpdateSiteVNETConnection", + "summary": "Updates the Virtual Network Gateway.", + "operationId": "Sites_CreateOrUpdateSiteVNETConnectionGatewaySlot", "consumes": [ "application/json", "text/json", @@ -14869,15 +15216,29 @@ "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 of this Virtual Network Connection", + "description": "The properties to update this gateway with.", "required": true, "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/VnetGateway" } }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/subscriptionIdParameter" }, @@ -14889,21 +15250,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/VnetInfo" + "$ref": "#/definitions/VnetGateway" } } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": { - "get": { + }, + "patch": { "tags": [ "Sites" ], - "summary": "Retrieves a list of all Virtual Network Connections associated with this web app.", - "operationId": "Sites_GetSiteVNETConnections", - "consumes": [], + "summary": "Updates the Virtual Network Gateway.", + "operationId": "Sites_UpdateSiteVNETConnectionGatewaySlot", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -14925,6 +15288,36 @@ "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" }, @@ -14936,23 +15329,20 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetInfo" - } + "$ref": "#/definitions/VnetGateway" } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": { "get": { "tags": [ "Sites" ], - "summary": "Retrieves a list of all Virtual Network Connections associated with this web app.", - "operationId": "Sites_GetSiteVNETConnectionsSlot", + "summary": "Retrieves a Virtual Network connection gateway associated with this web app and virtual network.", + "operationId": "Sites_GetSiteVnetGateway", "consumes": [], "produces": [ "application/json", @@ -14976,9 +15366,16 @@ "type": "string" }, { - "name": "slot", + "name": "vnetName", "in": "path", - "description": "The name of the slot for this web app.", + "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" }, @@ -14993,24 +15390,26 @@ "200": { "description": "OK", "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VnetInfo" - } + "$ref": "#/definitions/Object" } + }, + "404": { + "description": "Gateway does not exist. Only the \"primary\" gateway exists presently." } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": { - "get": { + }, + "put": { "tags": [ "Sites" ], - "summary": "Retrieves a view of all network features in use on this web app.", - "operationId": "Sites_GetSiteNetworkFeatures", - "consumes": [], + "summary": "Updates the Virtual Network Gateway.", + "operationId": "Sites_CreateOrUpdateSiteVNETConnectionGateway", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -15033,12 +15432,28 @@ "type": "string" }, { - "name": "view", + "name": "vnetName", "in": "path", - "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "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" }, @@ -15050,24 +15465,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/NetworkFeatures" + "$ref": "#/definitions/VnetGateway" } - }, - "404": { - "description": "The requested view does not exist." } }, "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": { - "get": { + }, + "patch": { "tags": [ "Sites" ], - "summary": "Retrieves a view of all network features in use on this web app.", - "operationId": "Sites_GetSiteNetworkFeaturesSlot", - "consumes": [], + "summary": "Updates the Virtual Network Gateway.", + "operationId": "Sites_UpdateSiteVNETConnectionGateway", + "consumes": [ + "application/json", + "text/json", + "application/x-www-form-urlencoded" + ], "produces": [ "application/json", "text/json", @@ -15090,19 +15504,28 @@ "type": "string" }, { - "name": "view", + "name": "vnetName", "in": "path", - "description": "The type of view. This can either be \"summary\" or \"detailed\".", + "description": "The name of the Virtual Network", "required": true, "type": "string" }, { - "name": "slot", + "name": "gatewayName", "in": "path", - "description": "The name of the slot for this web app.", + "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" }, @@ -15114,23 +15537,20 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/NetworkFeatures" + "$ref": "#/definitions/VnetGateway" } - }, - "404": { - "description": "The requested view does not exist." } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/operationresults/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": { "get": { "tags": [ "Sites" ], - "summary": "Gets the operation for a web app", - "operationId": "Sites_GetSiteOperation", + "summary": "Retrieves a list of all Virtual Network Connections associated with this web app.", + "operationId": "Sites_GetSiteVNETConnections", "consumes": [], "produces": [ "application/json", @@ -15142,21 +15562,14 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "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", + "description": "The name of the web app", "required": true, "type": "string" }, @@ -15171,20 +15584,23 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "type": "array", + "items": { + "$ref": "#/definitions/VnetInfo" + } } } }, "deprecated": false } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/operationresults/{operationId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": { "get": { "tags": [ "Sites" ], - "summary": "Gets the operation for a web app", - "operationId": "Sites_GetSiteOperationSlot", + "summary": "Retrieves a list of all Virtual Network Connections associated with this web app.", + "operationId": "Sites_GetSiteVNETConnectionsSlot", "consumes": [], "produces": [ "application/json", @@ -15196,28 +15612,21 @@ { "name": "resourceGroupName", "in": "path", - "description": "Name of resource group", + "description": "The resource group name", "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", + "description": "The 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.", + "description": "The name of the slot for this web app.", "required": true, "type": "string" }, @@ -15232,7 +15641,10 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/Object" + "type": "array", + "items": { + "$ref": "#/definitions/VnetInfo" + } } } }, @@ -15427,257 +15839,6 @@ } }, "definitions": { - "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" - } - } - }, - "CertificateOrderCertificate": { - "description": "Class representing the Key Vault container for certificate purchased through Azure", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "keyVaultCsmId": { - "description": "Key Vault Csm resource Id", - "type": "string" - }, - "keyVaultSecretName": { - "description": "Key Vault secret name", - "type": "string" - }, - "provisioningState": { - "description": "Status of the Key Vault secret", - "enum": [ - "Initialized", - "WaitingOnCertificateOrder", - "Succeeded", - "CertificateOrderFailed", - "OperationNotPermittedOnKeyVault", - "AzureServiceUnauthorizedToAccessKeyVault", - "KeyVaultDoesNotExist", - "KeyVaultSecretDoesNotExist", - "UnknownError", - "Unknown" - ], - "type": "string", - "x-ms-enum": { - "name": "KeyVaultSecretStatus", - "modelAsString": "False" - } - }, - "thumbprint": { - "description": "Thumbprint of the certificate stored in KeyVault", - "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": {} - }, - "CertificateOrder": { - "description": "Certificate purchase order", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "properties": { - "certificates": { - "description": "State of the Key Vault secret", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/CertificateOrderCertificate" - } - }, - "distinguishedName": { - "description": "Certificate distinguished name", - "type": "string" - }, - "domainVerificationToken": { - "description": "Domain Verification Token", - "type": "string" - }, - "validityInYears": { - "format": "int32", - "description": "Duration in years (must be between 1 and 3)", - "type": "integer" - }, - "keySize": { - "format": "int32", - "description": "Certificate Key Size", - "type": "integer" - }, - "productType": { - "description": "Certificate product type", - "enum": [ - "StandardDomainValidatedSsl", - "StandardDomainValidatedWildCardSsl" - ], - "type": "string", - "x-ms-enum": { - "name": "CertificateProductType", - "modelAsString": "False" - } - }, - "status": { - "description": "Current order status", - "enum": [ - "Pendingissuance", - "Issued", - "Revoked", - "Canceled", - "Denied", - "Pendingrevocation", - "PendingRekey", - "Unused", - "Expired", - "NotSubmitted" - ], - "type": "string", - "x-ms-enum": { - "name": "CertificateOrderStatus", - "modelAsString": "False" - } - }, - "signedCertificate": { - "description": "Signed certificate", - "type": "string" - }, - "csr": { - "description": "Last CSR that was created for this order", - "type": "string" - }, - "intermediate": { - "description": "Intermediate certificate", - "type": "string" - }, - "root": { - "description": "Root certificate", - "type": "string" - }, - "serialNumber": { - "description": "Current serial number of the certificate", - "type": "string" - }, - "action": { - "description": "Requested action on existing certificate order", - "enum": [ - "Rekey", - "Renew" - ], - "type": "string", - "x-ms-enum": { - "name": "CertificateAction", - "modelAsString": "False" - } - }, - "keyVaultCsmId": { - "description": "Key Vault Csm resource Id", - "type": "string" - }, - "delayExistingRevokeInHours": { - "format": "int32", - "description": "Delay in hours to revoke existing certificate after the new certificate is issued", - "type": "integer" - } - } - } - } - }, - "CertificateOrderCollection": { - "description": "Collection of ceritificate orders", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/CertificateOrder" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, - "CertificateOrderCertificateCollection": { - "description": "Collection of ceritificateorder certificates", - "type": "object", - "properties": { - "value": { - "description": "Collection of resources", - "type": "array", - "items": { - "$ref": "#/definitions/CertificateOrderCertificate" - } - }, - "nextLink": { - "description": "Link to next page of resources", - "type": "string" - } - } - }, "CertificateCollection": { "description": "Collection of certificates", "type": "object", @@ -15770,14 +15931,6 @@ "hostingEnvironmentProfile": { "$ref": "#/definitions/HostingEnvironmentProfile", "description": "Specification for the hosting environment (App Service Environment) to use for the certificate" - }, - "keyVaultCsmId": { - "description": "Key Vault Csm resource Id", - "type": "string" - }, - "keyVaultSecretName": { - "description": "Key Vault secret name", - "type": "string" } } } @@ -15801,6 +15954,63 @@ } } }, + "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", @@ -15952,7 +16162,21 @@ "type": "string", "x-ms-enum": { "name": "DomainStatus", - "modelAsString": "False" + "modelAsString": false + } + }, + "provisioningState": { + "description": "Domain provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false } }, "nameServers": { @@ -16074,7 +16298,7 @@ "type": "string", "x-ms-enum": { "name": "AzureResourceType", - "modelAsString": "False" + "modelAsString": false } }, "customHostNameDnsRecordType": { @@ -16086,7 +16310,7 @@ "type": "string", "x-ms-enum": { "name": "CustomHostNameDnsRecordType", - "modelAsString": "False" + "modelAsString": false } }, "hostNameType": { @@ -16098,7 +16322,7 @@ "type": "string", "x-ms-enum": { "name": "HostNameType", - "modelAsString": "False" + "modelAsString": false } } } @@ -16177,23 +16401,6 @@ "publishingPassword": { "description": "Password used for publishing", "type": "string" - }, - "lastUpdatedTime": { - "format": "date-time", - "description": "Timestamp when publishing credentials were last modified (internal)", - "type": "string" - }, - "metadata": { - "description": "User metadata (internal)", - "type": "string" - }, - "isDeleted": { - "description": "Indicates if user has been marked for deletion (internal)", - "type": "boolean" - }, - "scmUri": { - "description": "Url of SCM site (internal)", - "type": "string" } } } @@ -16288,7 +16495,7 @@ "readOnly": true, "x-ms-enum": { "name": "StatusOptions", - "modelAsString": "False" + "modelAsString": false } }, "subscription": { @@ -16400,7 +16607,7 @@ "readOnly": true, "x-ms-enum": { "name": "UsageState", - "modelAsString": "False" + "modelAsString": false } }, "enabled": { @@ -16426,7 +16633,7 @@ "readOnly": true, "x-ms-enum": { "name": "SiteAvailabilityState", - "modelAsString": "False" + "modelAsString": false } }, "hostNameSslStates": { @@ -16434,8 +16641,7 @@ "type": "array", "items": { "$ref": "#/definitions/HostNameSslState" - }, - "readOnly": true + } }, "serverFarmId": { "type": "string" @@ -16492,6 +16698,10 @@ "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", @@ -16549,7 +16759,7 @@ "type": "string", "x-ms-enum": { "name": "SslState", - "modelAsString": "False" + "modelAsString": false } }, "virtualIP": { @@ -16563,10 +16773,6 @@ "toUpdate": { "description": "Set this flag to update existing host name", "type": "boolean" - }, - "toUpdateIpBasedSsl": { - "description": "Set this flag to update existing host name", - "type": "boolean" } } }, @@ -16712,7 +16918,7 @@ "type": "string", "x-ms-enum": { "name": "ManagedPipelineMode", - "modelAsString": "False" + "modelAsString": false } }, "virtualApplications": { @@ -16734,7 +16940,7 @@ "type": "string", "x-ms-enum": { "name": "SiteLoadBalancing", - "modelAsString": "False" + "modelAsString": false } }, "experiments": { @@ -16761,6 +16967,14 @@ "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" @@ -16858,7 +17072,7 @@ "type": "string", "x-ms-enum": { "name": "DatabaseServerType", - "modelAsString": "False" + "modelAsString": false } } } @@ -16980,7 +17194,7 @@ "type": "string", "x-ms-enum": { "name": "UnauthenticatedClientAction", - "modelAsString": "False" + "modelAsString": false } }, "tokenStoreEnabled": { @@ -16995,7 +17209,7 @@ } }, "defaultProvider": { - "description": "Gets or sets the default authentication provider to use when multiple providers are configured.\r\n This settings is only needed if multiple providers are configured if the unauthenticated client\r\n action is set to \"RedirectToLoginPage\".", + "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", @@ -17006,7 +17220,7 @@ "type": "string", "x-ms-enum": { "name": "BuiltInAuthenticationProvider", - "modelAsString": "False" + "modelAsString": false } }, "clientId": { @@ -17058,7 +17272,7 @@ "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.google.com/identity/sign-in/web/", + "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" @@ -17089,6 +17303,29 @@ } } }, + "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" + } + } + }, "VirtualDirectory": { "type": "object", "properties": { @@ -17186,12 +17423,16 @@ "type": "string", "x-ms-enum": { "name": "AutoHealActionType", - "modelAsString": "False" + "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" } } }, @@ -17323,7 +17564,7 @@ "type": "string", "x-ms-enum": { "name": "HostingEnvironmentStatus", - "modelAsString": "False" + "modelAsString": false } }, "vnetName": { @@ -17352,7 +17593,7 @@ "type": "string", "x-ms-enum": { "name": "InternalLoadBalancingMode", - "modelAsString": "False" + "modelAsString": false } }, "multiSize": { @@ -17510,7 +17751,7 @@ "type": "string", "x-ms-enum": { "name": "ComputeModeOptions", - "modelAsString": "False" + "modelAsString": false } }, "workerSize": { @@ -17591,7 +17832,7 @@ "type": "string", "x-ms-enum": { "name": "ComputeModeOptions", - "modelAsString": "False" + "modelAsString": false } }, "workerSize": { @@ -17604,7 +17845,7 @@ "type": "string", "x-ms-enum": { "name": "WorkerSizeOptions", - "modelAsString": "False" + "modelAsString": false } }, "workerSizeId": { @@ -17637,7 +17878,7 @@ "type": "string", "x-ms-enum": { "name": "AccessControlEntryAction", - "modelAsString": "False" + "modelAsString": false } }, "description": { @@ -17701,7 +17942,7 @@ "type": "string", "x-ms-enum": { "name": "ManagedHostingEnvironmentStatus", - "modelAsString": "False" + "modelAsString": false } }, "virtualNetwork": { @@ -17736,6 +17977,10 @@ "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" } } } @@ -17768,7 +18013,7 @@ "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.", + "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": { @@ -17853,7 +18098,21 @@ "type": "string", "x-ms-enum": { "name": "DomainStatus", - "modelAsString": "False" + "modelAsString": false + } + }, + "provisioningState": { + "description": "Domain provisioning state", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false } }, "nameServers": { @@ -17936,7 +18195,7 @@ "type": "string", "x-ms-enum": { "name": "DomainType", - "modelAsString": "False" + "modelAsString": false } } } @@ -18369,7 +18628,7 @@ "type": "string", "x-ms-enum": { "name": "ComputeModeOptions", - "modelAsString": "False" + "modelAsString": false } }, "siteMode": { @@ -18598,6 +18857,73 @@ } } }, + "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" + } + } + } + } + } + }, + "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" + } + } + } + } + }, "CsmSlotEntity": { "description": "Class containing deployment slot parameters", "type": "object", @@ -18809,7 +19135,7 @@ "readOnly": true, "x-ms-enum": { "name": "UsageState", - "modelAsString": "False" + "modelAsString": false } }, "enabled": { @@ -18835,7 +19161,7 @@ "readOnly": true, "x-ms-enum": { "name": "SiteAvailabilityState", - "modelAsString": "False" + "modelAsString": false } }, "hostNameSslStates": { @@ -18843,8 +19169,7 @@ "type": "array", "items": { "$ref": "#/definitions/HostNameSslState" - }, - "readOnly": true + } }, "serverFarmId": { "type": "string" @@ -18901,6 +19226,10 @@ "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", @@ -18914,6 +19243,81 @@ } } }, + "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" + } + } + } + } + }, "SiteInstanceCollection": { "description": "Collection of site instances", "type": "object", @@ -19003,7 +19407,7 @@ "type": "string", "x-ms-enum": { "name": "AzureResourceType", - "modelAsString": "False" + "modelAsString": false } }, "customHostNameDnsRecordType": { @@ -19015,7 +19419,7 @@ "type": "string", "x-ms-enum": { "name": "CustomHostNameDnsRecordType", - "modelAsString": "False" + "modelAsString": false } }, "hostNameType": { @@ -19027,7 +19431,7 @@ "type": "string", "x-ms-enum": { "name": "HostNameType", - "modelAsString": "False" + "modelAsString": false } } } @@ -19127,7 +19531,7 @@ "type": "string", "x-ms-enum": { "name": "DatabaseServerType", - "modelAsString": "False" + "modelAsString": false } } } @@ -19221,7 +19625,7 @@ "type": "string", "x-ms-enum": { "name": "LogLevel", - "modelAsString": "False" + "modelAsString": false } } } @@ -19242,7 +19646,7 @@ "type": "string", "x-ms-enum": { "name": "LogLevel", - "modelAsString": "False" + "modelAsString": false } }, "sasUrl": { @@ -19267,7 +19671,7 @@ "type": "string", "x-ms-enum": { "name": "LogLevel", - "modelAsString": "False" + "modelAsString": false } }, "sasUrl": { @@ -19395,7 +19799,7 @@ "type": "string", "x-ms-enum": { "name": "BackupRestoreOperationType", - "modelAsString": "False" + "modelAsString": false } } } @@ -19423,7 +19827,7 @@ "type": "string", "x-ms-enum": { "name": "FrequencyUnit", - "modelAsString": "False" + "modelAsString": false } }, "keepAtLeastOneBackup": { @@ -19511,7 +19915,7 @@ "type": "string", "x-ms-enum": { "name": "BackupItemStatus", - "modelAsString": "False" + "modelAsString": false } }, "sizeInBytes": { @@ -19613,7 +20017,7 @@ "type": "string", "x-ms-enum": { "name": "BackupRestoreOperationType", - "modelAsString": "False" + "modelAsString": false } }, "adjustConnectionStrings": { @@ -19674,73 +20078,6 @@ } } }, - "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" - } - } - } - } - }, - "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" - } - } - } - } - } - }, "TopLevelDomainCollection": { "description": "Collection of Top Level Domains", "type": "object", diff --git a/documentation/creating-swagger.md b/documentation/creating-swagger.md new file mode 100644 index 000000000000..cc41d3d3f1a0 --- /dev/null +++ b/documentation/creating-swagger.md @@ -0,0 +1,771 @@ +# AutoRest Swagger +AutoRest is a tool for generating HTTP client libraries from Swagger files. This document explains the conventions +and extensions used by AutoRest in processing Swagger to produce client libraries. The Swagger specification can +be found at [Swagger RESTful API Documentation Specification](Swagger-spec2.0). + +1. [Swagger](#Swagger) +2. [Info Object](#InfoObject) +3. [Host](#Host) +4. [Schemes](#Schemes) +5. [Consumes / Produces](#ConsumesProduces) +6. [Paths](#Paths) +7. [Path Item](#PathItem) + 1. [Operation and OperationId](#OperationOperationId) + 2. [Parameters](#Parameters) + 1. [Path Parameters](#PathParameters) + 2. [Query Parameters](#QueryParameters) + 3. [Body Parameters](#BodyParameters) + 4. [Header Parameters](#HeaderParameters) + 5. [FormData Parameters](#FormDataParameters) + 3. [Responses](#Responses) + 1. [Default Response](#DefaultResponse) + 2. [Negative Responses](#NegativeResponses) +8. [Defining Model Types](#DefiningModel) + 1. [Model Inheritance](#ModelInheritance) + 2. [Polymorphic Response Models](#PolymorphicResponse) +9. [ResourceFlattening](#ResourceFlattening) + 1. [Conditions](#Conditions) + 2. [x-ms-azure-resource](#x-ms-azure-resource) +10. [Enums with x-ms-enum](#Enum-x-ms-enum) + 1. [Structure](#enum-structure) + 2. [Understanding modelAsString](#modelAsString) +11. [Paging with x-ms-pageable](#Paging-x-ms-pageable) + 1. [Structure](#paging-structure) + 2. [Pageable Operation](#pageOperation) + 3. [Pageable Model](#pageModel) +12. [URL Encoding](#UrlEncoding) +13. [Long Running operation](#longrunning) +14. [Global parameters](#globalParam) + +## Swagger +In this document, references to the 'spec' or to the 'swagger' refer to an instance of a Swagger file. AutoRest +supports Swagger version 2.0. The version of Swagger being used must be included in the spec. + +```json +{ + "swagger": "2.0" + ... +} +``` + +## Info Object +Each spec includes an "info object." +The **title** field is used as the name of the generated client. +```json +"info": { + "title": "MyClientName", +} +``` + +``` +var client = new MyClientName(); +``` +Override the title client name by passing the `-ClientName` to AutoRest. +>autorest.exe -ClientName MyClientName + +The version field specifies the service version of the API described in the spec. This is used as the default +value for Azure clients where api-version is passed in the querystring. +```json +"info": { + "version": "2014-04-01-preview" +``` + +``` +https://management.azure.com/...?api-version="2014-04-01-preview" +``` +## Host +The host field specifies the baseURI. (everything after the protocol and before the path). +``` json +{ + "swagger": "2.0", + "host": "management.azure.com" +} +``` + +## Schemes +The schemes field is an array of transfer protocols that can be used by individual operations. AutoRest supports +*http* and *https*. The generated client uses the first scheme from the array. +```json +{ + "swagger": "2.0", + "schemes": [ + "https", + "http" + ] + . . . +} +``` + +## Consumes / Produces +The *consumes* and *produces* fields declare the mime-types supported by the API. The root-level definition can +be overridden by individual operations. AutoRest supports JSON payloads. +```json +{ + "swagger": "2.0", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ] + . . . +} +``` + +## Paths +The paths object defines the relative paths of API endpoints (appended to the baseURI to invoke operations). +```json +"swagger": "2.0", +"paths": { + "/tenants": { + ... + }, + "/subscriptions": { + ... + } +} +``` + +``` +https://management.azure.com/tenants?api-version=2014-04-01-preview +OR +https://management.azure.com/subscriptions?api-version=2014-04-01-preview +``` +## Path Item +Each path item in the spec defines the operations available at that endpoint. The individual operations are +identified by the HTTP operation (sometimes referred to as HTTP verbs). AutoRest supports: **head**, **get**, +**put**, **post**, **delete** and **patch**. + +```json +{ + "swagger": "2.0", + "paths": { + "/stations": { + "get": { + ... + }, + "put": { + ... +``` +### Operation and OperationId +Every operation must have a unique operationId. The operationId is used to determine the generated method name. +```json +"paths": { + "/users": { + "get": { + "operationId": "ListUsers" + } + } +``` + +```csharp +var client = new MyClientName(); +var listResult = client.ListUsers(); +IList users = listResult.Value; +``` +All of the operations specified become methods on the client. The client API model can easily become a long and +cumbersome list of methods. AutoRest allows grouping of operations by using a naming convention. Operation groups +are identified by splitting the operationId by underscore. +```json +"paths": { + "/{tenantId}/users": { + "get": { + "operationId": "Users_List", + ... +``` +instead of +```csharp +var listResult = client.ListUsers(); +``` +the method becomes part of an operation group interface + +```csharp +var listResult = client.Users.List(); +``` +The operation group interface and the interface implementation is the "core" of the operation. Other signatures of +this API ultimately call the "core" implementation. This allows the operations to be easily mocked for testing without +needing to mock all signature variations. Other API signatures for the same operation are generated as extension methods. +For example, consider this `GetUserById` operation on the `SampleClient`. +```json +"/users/{userId}": { + "get": { + "operationId": "Users_GetById" +... +``` +The generated method signature is in the `IUsers` interface +```csharp +public interface IUsers +{ + Task> GetByIdWithOperationResponseAsync(string userId, CancellationToken cancellationToken = default(CancellationToken)); +} +``` +The core signature returns a generic HttpOperationResponse which includes the HttpRequest and HttpResponse objects as +well as the payload object. In addition to the "core" signature, there is a synchronous version and an async version +that returns the payload object without the request and response objects. +```csharp +public static partial class UsersExtensions +{ + public static User GetById(this IUser operations, string userId) {...} + + public static async Task GetByIdAsync( this IUser operations, string userId, CancellationToken cancellationToken = default(CancellationToken)) {...} +} +``` + +### Parameters +Each operation defines the parameters that must be supplied. An operation may not require any parameters. A parameter +defines a name, description, schema, what request element it is `in` (AutoRest supports parameters in the **path**, **query**, +**header**, and **body** of the request) and whether or not is it `required`. + +#### Path Parameters +The value of path parameters are replaced in the templated URL path at the position specified by the name. Parameters that +are `in` the `path` must have a `true` value for the `required` field. In this example, the `{userId}` in this operation +is populated with the value of userId provided in the client method. +```json +"paths": { + "/users/{userid}": { + "get": { + "operationId": "users_getById", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the user." + } + ] + } + } +} +``` +In the generated code, the path parameter is an argument of the method. +```csharp +string userId = "abcxyz"; +var user = client.Users.GetById(userId); +``` +>https://{host}/{basePath}/users/abcxyz + +#### Query Parameters +Query parameters are appended to the request URI. They can be specified as required or optional. +```json +"paths": { + "/users/{userId}": { + "get": { + "operationId": "users_getUserById", + "parameters": [ + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of API to invoke." + } + ] + } + } +} +``` +The user doesn't need to know where the parameter is placed. Doc comments surface the required/optional distinction. + +####Body Parameters +Body parameters include schema for the payload. In this example, the schema element is a `$ref` to the type details +in the `#/definitions` section of the spec. More on the `#/definitions` later. +```json +"paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Storage/checkNameAvailability": { + "post": { + "operationId": "StorageAccounts_CheckNameAvailability", + "parameters": [ + { + "name": "accountName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCheckNameAvailabilityParameters" + } + } + ], + ... +``` + +#### Header Parameters +>TODO: Header parameters + +#### FormData Parameters +>Note: FormData parameters are not currently supported by AutoRest. + +### Responses +Each operation defines the possible responses by HTTP status code: +```json +"/users/{userId}": { + "get": { + "operationId": "users_getUserById", + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/user" + } + } + } + } +} +``` + +#### Default Response +Swagger allows for specifying a `default` response. AutoRest treats the `default` response as defining an error +response status code unless `default` is the only status code defined. The reason for imposing this convention is +to produce higher quality API signatures. The return type of the generated API is determined by finding a common +base type of the success responses. In practice, if the default is considered as a potential success defintion, +the common ancestor of success responses and error responses ends up being Object. + +### Negative Responses +You can describe all the [possible HTTP Response status codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) in the responses section of an operation. AutoRest generated code will deserialize the response for all the described response status codes as per their definition in the swagger. If a response status code is not defined then generated code will align to the default response behavior as described above. For example: If you want to specifically handle `400` and `404` in different way and **not throw an exception**, then you should describe `400` and `404` response status codes possibly with a schema. In that case, AutoRest generated code will deserialize the `400` and `404` response status codes as defined in Swaggger and not throw an exception. +```json +"/users/{userId}": { + "get": { + "operationId": "users_getUserById", + "responses": { + "200": { + "description": "Provides User Information.", + "schema": { + "$ref": "#/definitions/user" + } + }, + "400": { + "description": "Bad Request. ResponseBody will be deserialized as per the Error definition + mentioned in schema. Exception will not be thrown.", + "schema": { + "$ref": "#/definitions/Error" + } + }, + "404": { + "description": "Resource Not Found, ResponseBody will be null as there is no schema definition. + Exception will not be thrown.", + }, + "default": { + "description": "Default Response. It will be deserialized as per the Error defintion + specified in the schema. Exception will be thrown.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } +} +``` +### Custom Paths +Swagger 2.0 has a built-in limitation on paths. Only one operation can be mapped to a path and http method. There are some APIs, however, where multiple distinct operations are mapped to the same path and same http method. For example `GET /mypath/query-drive?op=file` and `GET /mypath/query-drive?op=folder` may return two different model types (stream in the first example and JSON model representing Folder in the second). Since Swagger does not treat query parameters as part of the path the above 2 operations may not co-exist in the standard "paths" element. + +To overcome this limitation an "x-ms-paths" extension was introduced parallel to "paths". Urls under "x-ms-paths" are allowed to have query parameters for disambiguation, however they are removed during model parsing. + +```json +"paths":{ + "/pets": { + "get": { + "parameters": [ + { + "name": "name", + "required": true + } + ] + } + } +}, +"x-ms-paths":{ + "/pets?color={color}": { + "get": {} + }, +} + +``` + +Please note, that the use of "x-ms-paths" should be minimized to the above scenarios. Since any metadata inside the extension is not part of the default swagger specification, it will not be available to non-AutoRest tools. + +## Defining Model Types +The request body and response definitions become simple model types in the generated code. The models include +basic validation methods, but are generally stateless serialization definitions. + +### Model Inheritance +Swagger schema allows for specifying that one type is `allOf` other types, meaning that the entire specification of +the referenced schema applies is included in the new schema. By convention, if a schema has an 'allOf' that references +only one other schema, AutoRest treats this reference as an indication that the `allOf` schema represents a base +type being extended. In this example, the generated code would include a `Dog` model that inherits from the `Pet` model. + +```json +{ + "definitions": { + "pet": { + "properties": { + "name": { + "type": "string" + }, + }, + "required": [ + "name" + ] + }, + "dog": { + "allOf": [ + { + "$ref": "#/definitions/pet" + } + ], + "properties": { + "breed": { + "type": "string" + }, + "required": [ + "breed" + ] + } + } + } +} +``` + +### Polymorphic Response Models +Besides using `allOf` to define inheritance, model definitions can indicate that the payload will include a `discriminator` +to disambiguate polymorphic payloads. The discriminator field allows the deserializer to resolve into an instance of a more +specific type. Suppose the Dog and Cat type are `allOf` Pet and an operation will return a Dog or a Cat. If the Pet definition +includes a `discriminator` then payloads can be Dog or Cat. A response can be defined as a Pet model and the API signature +will indicate Pet. At runtime, the returned object is an instance of the more specific type. +```json +{ + "definitions": { + "pet": { + "properties": { + "name": { + "type": "string", + "discriminator": "petType" + }, + }, + "required": [ + "name", + "petType" + ] + } + } +``` + + +## Defining Azure Resource Types with x-ms-azure-resource (Resource Flattening) +Azure Resource Manager brings a common pattern that is leveraged to provide a more consistent programming model for users. +Resource types all have a common set of Resource properties: id, name, location, tags... +In a resource payload, the common properties are at the top-level and the resource-specific properties are nested within +`properties`. The top-level outer properties are sometimes referred to as the 'ARM envelope' and the inner data as the 'Resource properties.' +```json +{ + "id": "/subscriptions/{id}/resourceGroups/{group}/providers/{rpns}/{type}/{name}", + "name": "Resource Name", + "type": "Microsoft.ResourceProvider/type", + "location": "North US", + "properties": { + "foo" : { + "name" : "{fooA|fooB|fooC}", + "capacity" : {number} + }, + "bar": "flim" + } +} +``` +When the ARM payload shape is reflected directly into the client object model, the nesting of the Resource-specific +'properties' within the 'properties' object becomes cumbersome. +```csharp +var theResource = theClient.GetResourceById(resourceId); +theResource.Properties.Foo.Name = "fooB"; +theResource.Properties.Foo.Capacity = 100; +theResource.Properties.Bar = "flam"; +``` +To provide a **better end-user experience**, types that are identified as ARM resources are **"flattened"** in the generated C# code. +The serialization and deserialization of Resource types hides the "properties" nesting from the user. +```csharp +var theResource = theClient.GetResourceById(resourceId); +theResource.Location = "North US"; +theResource.Foo.Name = "fooB"; +theResource.Foo.Capacity = 100; +``` +### When will AutoRest flatten resources? +If any model or its parent is marked with an extension `"x-ms-azure-resource" : true`, then AutoRest will flatten the +Resource-specific properties by one level for that model. + +### x-ms-azure-resource +In using Swagger to describe Azure Resource Manager operations, types are identified as Resources by declaring that a type +is "allOf" the common `Resource` type. That common `Resource` type includes the `x-ms-azure-resource` Swagger extension. +```json + "Resource": { + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource Type" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource Tags" + }, + "location": { + "type": "string", + "description": "Resource Location" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource Name" + } + } + } + ``` +**Notice that the type definitions in Swagger schema use the word 'properties' to identify the 'properties' of the type. When +looking at an ARM Resource it also has 'properties', the 'properties' term is overloaded and it looks a bit odd.** + +In practice, the Resource properties may be re-used in the Swagger spec and can be defined separately. If the schema of the +resource properties is included inline, AutoRest still needs to generate a type for the properties and does so by appending +`Properties` to the Resource name +```json +"definitions": { + "SomeResourceProperties": { + "properties": { + "bar": { + "type": "string" + } + } + }, + "SomeResource": { + "properties": { + "properties": { + "$ref": "#/definitions/SomeResourceProperties" + } + }, + "allOf": [ + { + "$ref": "Resource" + } + ] + } +} +``` +## Enums with x-ms-enum +Enum definitions in Swagger indicate that only a particular set of values may be used for a property or parameter. When +the property is represented on the wire as a string, it would be a natural choice to represent the property type in C# +as an enum. However, not all enumeration values should necessarily be represented as C# enums - there are additional +considerations, such as how often expected values might change, since adding a new value to a C# enum is a breaking change +requiring an updated API version. Additionally, there is some metadata that is required to create a useful C# enum, such +as a descriptive name, which is not represented in swagger. For this reason, enums are not automatically turned into +enum types in C# - instead they are rendered in the documentation comments for the property or parameter to indcate allowed +values. To indicate that an enum will rarely change and that C# enum semantics are desired, use the `x-ms-enum` exension. + +In C#, an enum type is generated and is declared as the type of the related request/response object. The enum is serialized +as the string expected by the REST API. +```json + "accountType": { + "type": "string", + "enum": [ + "Standard_LRS", + "Standard_ZRS", + "Standard_GRS", + "Standard_RAGRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "AccountType", + "modelAsString": false + } + } +``` + +### x-ms-enum extension structure +``` +{ + "x-ms-enum": { + "name" : "Specify the name for the Enum." + "modelAsString": "true/false." + } +} +``` +### modelAsString +- **true** + - When set to `true` the `enum` will be modeled as a `string`. No validation will happen. +- **false** + - When set to `false`, it will be modeled as an `enum` if that language supports enums. Validation will happen, irrespective of support of enums in that language. + +## Paging with x-ms-pageable +The REST API guidelines define a common pattern for paging through lists of data. The operation response is modeled in +Swagger as the list of items and the `nextLink`. Tag the operation as `x-ms-pageable` and the generated code will include +methods for navigating between pages. + +#### x-ms-pageable extension structure +```json +{ + "x-ms-pageable" : { + "nextLinkName": "Specify the name of the property that provides the nextLink. + If your model does not have the nextLink property then specify null.", + "itemName": "Specify the name of the property that provides the collection + of pageable items. It is optional. Default value is 'value'.", + "operationName": "Specify the name of the Next operation. It is optional. Default value is 'XXXNext' where XXX is the name of the operation." + } +} +``` +#### x-ms-pageable operation definition +```json +"paths": { + "/products": { + "get": { + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "products_list", + "description": "A pageable list of Products.", + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/ProductListResult" + } + } + } + } + } +} +``` +#### x-ms-pageable model definition +```json +"ProductListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Product" + } + }, + "nextLink": { + "type": "string" + } + } +} +``` + +## Control URL encoding with x-ms-skip-url-encoding +By default, `path` parameters will be URL-encoded automatically. This is a good default choice for user-provided values. +This is not a good choice when the parameter is provided from a source where the value is known to be URL-encoded. +The URL encoding is *NOT* an idempotent operation. For example, the percent character "%" is URL-encoded as "%25". If the +parameter is URL-encoded again, "%25" becomes "%2525". Mark parameters where the source is KNOWN to be URL-encoded to +prevent the automatic encoding behavior. +```json +"parameters": [ + { + "name": "databaseName", + "in": "path", + "type": "string", + "required": true, + "x-ms-skip-url-encoding": true + } +] +``` + +## Enable Asynchronous Operations with x-ms-long-running-operation +Some requests like creating/deleting a resource cannot be carried out immediately. In such a situation, the server +sends a 201 (Created) or 202 (Accepted) and provides a link to monitor the status of the request. When such an operation +is marked with extension `"x-ms-long-running-operation": true,` in Swagger, the generated code will know how to fetch +the link to monitor the status. It will keep on polling at regular intervals till the request reaches one of the +terminal states`Succeeded|Failed|Canceled`. +```json +"paths": { + "/products/{name}": { + "put": { + "operationId": "products_create", + "x-ms-long-running-operation": true, + "description": "A pageable list of Products.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Product." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProductCreateParameters" + }, + "description": "The parameters to provide for the created product." + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Product" + } + }, + "202": { + "description": "" + } + } + } + } +} +``` + +##Global parameters +Swagger allows for parameters to be defined separately from the operation where they are used. By convention, AutoRest +treats global parameter definitions as Client properties. For example, almost all Azure Resource Manager APIs require +`subscriptionId` and `api-version`. These are defined as global parameters and become properties of the client. +```json +"parameters": [ + { + "name": "subscriptionId", + "type": "string" + } +] +``` + +```csharp +var client = new MyClient(); +client.SubscriptionId = "xyz-123"; +``` +By convention, when AutoRest sees that an operation defines a parameter as a reference to a global parameter, the generated +method does not expose the parameter. Instead, the parameter is populated with the value from the client property. + +```json +"paths": { + "/subscriptions/{subscriptionId}/providers/MyProvider/SomeOperation": { + "post": { + "parameters": [{"$ref": "#/parameters/subscriptionId"}] + } + } +} +``` +If an operation requires that a parameter is exposed as a method parameter, it is defined without referencing the global definition. +```json +"paths": { + "/subscriptions/{subscriptionId}/providers/MyProvider/SomeOperation": { + "post": { + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + } + ] + } + } +} +``` + +## x-ms-odata +>TODO: x-ms-odata + +TODO: naming standards for operations Create, CreateOrUpdate, Update (respect etag), Get, List, Delete, Patch +TODO: patch => no validate +[Swagger-spec2.0]:https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md diff --git a/package.json b/package.json index 5ef09d817cbd..86231752d893 100644 --- a/package.json +++ b/package.json @@ -21,8 +21,7 @@ "glob": "^5.0.14", "lodash": "^3.10.1", "request": "^2.61.0", - "swagger-validator": "swagger-api/swagger-spec", - "z-schema": "^2.4.9" + "z-schema": "^3.16.1" }, "devDependencies": {}, "homepage": "https://github.com/azure/azure-rest-api-specs", diff --git a/search/2015-02-28/swagger/searchindex.json b/search/2015-02-28/swagger/searchindex.json index fd34515ecb35..30f0fd9f27c5 100644 --- a/search/2015-02-28/swagger/searchindex.json +++ b/search/2015-02-28/swagger/searchindex.json @@ -30,14 +30,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", diff --git a/search/2015-02-28/swagger/searchservice.json b/search/2015-02-28/swagger/searchservice.json index 93e0bc19b316..c4a775c9c4c1 100644 --- a/search/2015-02-28/swagger/searchservice.json +++ b/search/2015-02-28/swagger/searchservice.json @@ -47,14 +47,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -94,14 +94,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "204": { "description": "" @@ -135,14 +135,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -171,14 +171,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -215,14 +215,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "201": { "description": "", @@ -258,14 +258,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "204": { "description": "" @@ -298,14 +298,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "202": { "description": "" @@ -347,14 +347,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "201": { "description": "", @@ -394,14 +394,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "404": { "description": "" @@ -435,14 +435,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -471,14 +471,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -514,14 +514,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "201": { "description": "", @@ -557,14 +557,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -602,14 +602,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "201": { "description": "", @@ -643,14 +643,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -695,14 +695,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -742,14 +742,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "204": { "description": "" @@ -783,14 +783,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", @@ -826,14 +826,14 @@ "type": "string", "format": "uuid", "description": "Tracking ID sent with the request to help with debugging.", - "x-ms-client-request-id": { "value": "true" }, + "x-ms-client-request-id": true, "x-ms-parameter-grouping": { "name": "search-request-options" } }, { "$ref": "#/parameters/ApiVersionParameter" } ], - "x-ms-request-id": { "value": "request-id" }, + "x-ms-request-id": "request-id", "responses": { "200": { "description": "", diff --git a/test/test.js b/test/test.js index 50b1184999d1..9fab521edd9e 100644 --- a/test/test.js +++ b/test/test.js @@ -6,44 +6,46 @@ _ = require('lodash'), z = require('z-schema'), request = require("request") +var extensionSwaggerSchemaUrl = "https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json"; +var swaggerSchemaUrl = "http://json.schemastore.org/swagger-2.0"; +var swaggerSchemaAltUrl = "http://swagger.io/v2/schema.json"; +var schemaUrl = "http://json-schema.org/draft-04/schema"; +var swaggerSchema; +var extensionSwaggerSchema; +var schema4; + var globPath = path.join(__dirname, '../', '/**/swagger/*.json'); var swaggers = _(glob.sync(globPath)); -var schema = JSON.parse(fs.readFileSync( - path.join( - __dirname, - '../node_modules/swagger-validator/schemas/v2.0/schema.json' - ), 'utf8')); - - describe('Azure Swagger Schema Validation', function() { before(function(done) { - request({ - url: "http://json-schema.org/draft-04/schema" - }, - function (error, response, body) { - if (!error && response.statusCode === 200) { - z.setRemoteReference("http://json-schema.org/draft-04/schema", body); + request({url: extensionSwaggerSchemaUrl, json:true}, function (error, response, extensionSwaggerSchemaBody) { + request({url: swaggerSchemaAltUrl, json:true}, function (error, response, swaggerSchemaBody) { + request({url: schemaUrl, json:true}, function (error, response, schemaBody) { + extensionSwaggerSchema = extensionSwaggerSchemaBody; + swaggerSchema = swaggerSchemaBody; + schema4 = schemaBody; done(); - } else { - done(new Error("Request failed")); - } + }); }); + }); }); _(swaggers).each(function(swagger){ it(swagger + ' should be valid Swagger', function(done){ - var validator = new z(); fs.readFile(swagger, 'utf8', function(err, data){ if(err) { done(err); } - validator.validate(JSON.parse(data), schema, function (err, result) { - if(err) { - done(new Error(JSON.stringify(err, null, "\t"))); - } else { - assert.equal(result.valid, true, JSON.stringify(validator.getLastError(), null, "\t")); - done(); - } - }); + + var validator = new z(); + validator.setRemoteReference(schemaUrl, schema4); + validator.setRemoteReference(swaggerSchemaUrl, swaggerSchema); + var valid = validator.validate(JSON.parse(data), extensionSwaggerSchema); + if (!valid) { + var error = validator.getLastErrors(); + throw new Error("Schema validation failed: " + JSON.stringify(error, null, "\t")); + } + assert(valid == true); + done(); }); }); }).value();