diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json index dd653a2a7d6f..9c7b0d7ee85e 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json @@ -64,6 +64,15 @@ "description": "Create a new Service or update an exiting Service.", "operationId": "Services_CreateOrUpdate", "parameters": [ + { + "name": "resource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -75,15 +84,6 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "name": "resource", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResource" - } } ], "responses": { @@ -167,6 +167,15 @@ "description": "Operation to update an exiting Service.", "operationId": "Services_Update", "parameters": [ + { + "name": "resource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -178,15 +187,6 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "name": "resource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/ServiceResource" - } } ], "responses": { @@ -270,6 +270,15 @@ "description": "Regenerate a test key for a Service.", "operationId": "Services_RegenerateTestKey", "parameters": [ + { + "name": "regenerateTestKeyRequest", + "in": "body", + "description": "Parameters for the operation", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateTestKeyRequestPayload" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -281,15 +290,6 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "name": "regenerateTestKeyRequest", - "in": "body", - "description": "Parameters for the operation", - "required": true, - "schema": { - "$ref": "#/definitions/RegenerateTestKeyRequestPayload" - } } ], "responses": { @@ -450,6 +450,15 @@ "description": "Create a new App or update an exiting App.", "operationId": "Apps_CreateOrUpdate", "parameters": [ + { + "name": "appResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/AppResource" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -464,15 +473,6 @@ }, { "$ref": "#/parameters/AppNameParameter" - }, - { - "name": "appResource", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/AppResource" - } } ], "responses": { @@ -555,6 +555,15 @@ "description": "Operation to update an exiting App.", "operationId": "Apps_Update", "parameters": [ + { + "name": "appResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/AppResource" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -569,15 +578,6 @@ }, { "$ref": "#/parameters/AppNameParameter" - }, - { - "name": "appResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/AppResource" - } } ], "responses": { @@ -755,6 +755,15 @@ "description": "Create a new Binding or update an exiting Binding.", "operationId": "Bindings_CreateOrUpdate", "parameters": [ + { + "name": "bindingResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -772,15 +781,6 @@ }, { "$ref": "#/parameters/BindingNameParameter" - }, - { - "name": "bindingResource", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/BindingResource" - } } ], "responses": { @@ -856,6 +856,15 @@ "description": "Operation to update an exiting Binding.", "operationId": "Bindings_Update", "parameters": [ + { + "name": "bindingResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/BindingResource" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -873,15 +882,6 @@ }, { "$ref": "#/parameters/BindingNameParameter" - }, - { - "name": "bindingResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/BindingResource" - } } ], "responses": { @@ -953,20 +953,20 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/locations/{location}/checkNameAvailability": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}": { + "get": { "tags": [ "AppPlatform" ], - "description": "Checks that the resource name is valid and is not already in use.", - "operationId": "Services_CheckNameAvailability", + "description": "Get the certificate resource.", + "operationId": "Certificate_GetAsync", "parameters": [ { - "name": "location", + "name": "CertificateName", "in": "path", - "description": "the region", "required": true, - "type": "string" + "type": "string", + "pattern": "^[a-z0-9-]{1,127}$" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -975,20 +975,17 @@ "$ref": "#/parameters/SubscriptionIdParameter" }, { - "name": "availabilityParameters", - "in": "body", - "description": "Parameters supplied to the operation.", - "required": true, - "schema": { - "$ref": "#/definitions/NameAvailabilityParameters" - } + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the name availability.", + "description": "Success. The response describe the certificate.", "schema": { - "$ref": "#/definitions/NameAvailability" + "$ref": "#/definitions/CertificateResource" } }, "default": { @@ -999,46 +996,56 @@ } }, "x-ms-examples": { - "Services_CheckNameAvailability": { - "$ref": "./examples/Services_CheckNameAvailability.json" + "Certificate_GetAsync": { + "$ref": "./examples/Certificate_GetAsync.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}": { - "get": { + }, + "put": { "tags": [ "AppPlatform" ], - "description": "Get a Deployment and its properties.", - "operationId": "Deployments_Get", + "description": "Create or update certificate resource.", + "operationId": "Certificate_CreateOrUpdateAsync", "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" + "name": "CertificateName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9-]{1,127}$" }, { - "$ref": "#/parameters/SubscriptionIdParameter" + "name": "certificateResource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateResource" + } }, { - "$ref": "#/parameters/ResourceGroupNameParameter" + "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/ServiceNameParameter" + "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/AppNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/DeploymentNameParameter" + "$ref": "#/parameters/ServiceNameParameter" } ], "responses": { "200": { - "description": "Success. The response describes the corresponding Deployment.", + "description": "Success. The response describe the existed certificate updated.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/CertificateResource" } }, + "201": { + "description": "Created. The response describe the new certificate created." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -1046,19 +1053,30 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "x-ms-examples": { - "Deployments_Get": { - "$ref": "./examples/Deployments_Get.json" + "Certificate_CreateOrUpdateAsync": { + "$ref": "./examples/Certificate_CreateOrUpdateAsync.json" } } }, - "put": { + "delete": { "tags": [ "AppPlatform" ], - "description": "Create a new Deployment or update an exiting Deployment.", - "operationId": "Deployments_CreateOrUpdate", + "description": "Delete the certificate resource.", + "operationId": "Certificate_DeleteAsync", "parameters": [ + { + "name": "CertificateName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9-]{1,127}$" + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -1070,34 +1088,19 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/DeploymentNameParameter" - }, - { - "name": "deploymentResource", - "in": "body", - "description": "Parameters for the create or update operation", - "required": true, - "schema": { - "$ref": "#/definitions/DeploymentResource" - } } ], "responses": { - "201": { - "description": "Created. The response describes the new Deployment and contains a Location header to query the\r\noperation result.", + "200": { + "description": "Success. The response indicates the certificate deleted.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/CertificateResource" } }, - "200": { - "description": "Success. The response describes the updated Deployment.", + "204": { + "description": "No content. The response indicates the certificate doesn't exist.", "schema": { - "$ref": "#/definitions/DeploymentResource" + "$ref": "#/definitions/CertificateResource" } }, "default": { @@ -1107,23 +1110,28 @@ } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, "x-ms-examples": { - "Deployments_CreateOrUpdate": { - "$ref": "./examples/Deployments_CreateOrUpdate.json" + "Certificate_DeleteAsync": { + "$ref": "./examples/Certificate_DeleteAsync.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates": { + "get": { "tags": [ "AppPlatform" ], - "description": "Operation to delete a Deployment.", - "operationId": "Deployments_Delete", + "description": "List all the certificates of one user.", + "operationId": "Certificate_ListAsync", "parameters": [ + { + "name": "CertificateName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z0-9-]{1,127}$" + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -1135,20 +1143,14 @@ }, { "$ref": "#/parameters/ServiceNameParameter" - }, - { - "$ref": "#/parameters/AppNameParameter" - }, - { - "$ref": "#/parameters/DeploymentNameParameter" } ], "responses": { "200": { - "description": "Success. The response indicates the resource is deleted." - }, - "204": { - "description": "Success. The response indicates the resource doesn't exist." + "description": "Success. The response describe the custom domain resource list of one application.", + "schema": { + "$ref": "#/definitions/CertificateResourceCollection" + } }, "default": { "description": "Error response describing why the operation failed.", @@ -1158,18 +1160,509 @@ } }, "x-ms-examples": { - "Deployments_Delete": { - "$ref": "./examples/Deployments_Delete.json" + "Certificate_ListAsync": { + "$ref": "./examples/Certificate_ListAsync.json" } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppPlatform/locations/{location}/checkNameAvailability": { + "post": { "tags": [ "AppPlatform" ], - "description": "Operation to update an exiting Deployment.", - "operationId": "Deployments_Update", + "description": "Checks that the resource name is valid and is not already in use.", + "operationId": "Services_CheckNameAvailability", "parameters": [ + { + "name": "location", + "in": "path", + "description": "the region", + "required": true, + "type": "string" + }, + { + "name": "availabilityParameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Services_CheckNameAvailability": { + "$ref": "./examples/Services_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains/{domainName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get the custom domain of one lifecycle application.", + "operationId": "CustomDomains_GetAsync", + "parameters": [ + { + "name": "DomainName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the custom domain.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomDomains_GetAsync": { + "$ref": "./examples/CustomDomains_GetAsync.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create or update custom domain of one lifecycle application.", + "operationId": "CustomDomains_CreateOrUpdateAsync", + "parameters": [ + { + "name": "DomainName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "domainResource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the existed custom domain updated.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomDomains_CreateOrUpdateAsync": { + "$ref": "./examples/CustomDomains_CreateOrUpdateAsync.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Delete the custom domain of one lifecycle application.", + "operationId": "CustomDomains_DeleteAsync", + "parameters": [ + { + "name": "DomainName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the custom domain deleted.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "204": { + "description": "No content. The response indicates the custom domain doesn't exist.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomDomains_DeleteAsync": { + "$ref": "./examples/CustomDomains_DeleteAsync.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Update custom domain of one lifecycle application.", + "operationId": "CustomDomains_PatchAsync", + "parameters": [ + { + "name": "DomainName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "domainResource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the existed custom domain updated.", + "schema": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomDomains_PatchAsync": { + "$ref": "./examples/CustomDomains_PatchAsync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/domains": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "List the custom domains of one lifecycle application.", + "operationId": "CustomDomains_ListAsync", + "parameters": [ + { + "name": "DomainName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the custom domain resource list of one application.", + "schema": { + "$ref": "#/definitions/CustomDomainResourceCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CustomDomains_ListAsync": { + "$ref": "./examples/CustomDomains_ListAsync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/apps/{appName}/deployments/{deploymentName}": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "Get a Deployment and its properties.", + "operationId": "Deployments_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding Deployment.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Deployments_Get": { + "$ref": "./examples/Deployments_Get.json" + } + } + }, + "put": { + "tags": [ + "AppPlatform" + ], + "description": "Create a new Deployment or update an exiting Deployment.", + "operationId": "Deployments_CreateOrUpdate", + "parameters": [ + { + "name": "deploymentResource", + "in": "body", + "description": "Parameters for the create or update operation", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "201": { + "description": "Created. The response describes the new Deployment and contains a Location header to query the\r\noperation result.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "200": { + "description": "Success. The response describes the updated Deployment.", + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Deployments_CreateOrUpdate": { + "$ref": "./examples/Deployments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to delete a Deployment.", + "operationId": "Deployments_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/AppNameParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response indicates the resource is deleted." + }, + "204": { + "description": "Success. The response indicates the resource doesn't exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Deployments_Delete": { + "$ref": "./examples/Deployments_Delete.json" + } + } + }, + "patch": { + "tags": [ + "AppPlatform" + ], + "description": "Operation to update an exiting Deployment.", + "operationId": "Deployments_Update", + "parameters": [ + { + "name": "deploymentResource", + "in": "body", + "description": "Parameters for the update operation", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentResource" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -1187,15 +1680,6 @@ }, { "$ref": "#/parameters/DeploymentNameParameter" - }, - { - "name": "deploymentResource", - "in": "body", - "description": "Parameters for the update operation", - "required": true, - "schema": { - "$ref": "#/definitions/DeploymentResource" - } } ], "responses": { @@ -1634,6 +2118,30 @@ } } }, + "/internal/health": { + "get": { + "tags": [ + "AppPlatform" + ], + "operationId": "Health_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/providers/Microsoft.AppPlatform/operations": { "get": { "tags": [ @@ -1669,6 +2177,66 @@ } } } + }, + "/providers/Microsoft.AppPlatform/runtimeVersions": { + "get": { + "tags": [ + "AppPlatform" + ], + "description": "You can directly pass \"{value[i].value}\" attribute (in the response) to all deployment CRUD operations.", + "operationId": "RuntimeVersions_ListRuntimeVersions", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the details of all supported deployment runtime versions.", + "schema": { + "$ref": "#/definitions/AvailableRuntimeVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RuntimeVersions_ListRuntimeVersions": { + "$ref": "./examples/RuntimeVersions_ListRuntimeVersions.json" + } + } + } + }, + "/skus": { + "get": { + "tags": [ + "AppPlatform" + ], + "operationId": "Sku_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ResourceTypeSkuCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } } }, "definitions": { @@ -1685,6 +2253,10 @@ "$ref": "#/definitions/ClusterResourceProperties", "description": "Properties of the Service resource", "x-ms-client-flatten": false + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the Service resource" } } }, @@ -1777,6 +2349,22 @@ } } }, + "Sku": { + "description": "Sku of Azure Spring Cloud", + "type": "object", + "properties": { + "name": { + "description": "Name of the Sku", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "Tier of the Sku", + "type": "string", + "readOnly": true + } + } + }, "ConfigServerProperties": { "description": "Config server git properties payload", "type": "object", @@ -2075,7 +2663,8 @@ "Succeeded", "Failed", "Creating", - "Updating" + "Updating", + "Deleting" ], "type": "string", "readOnly": true, @@ -2256,6 +2845,61 @@ } } }, + "CertificateResource": { + "description": "Certificate resource payload.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProperties", + "description": "Properties of the certificate resource payload." + } + } + }, + "CertificateProperties": { + "description": "Certificate resource payload.", + "required": [ + "keyvaultCertificateName", + "vaultUri" + ], + "type": "object", + "properties": { + "keyvaultResourceId": { + "description": "The resource id of user keyvault.", + "type": "string" + }, + "keyvaultCertificateName": { + "description": "The certificate name of user keyvault.", + "type": "string" + }, + "vaultUri": { + "description": "The vault uri of user key vault.", + "type": "string" + } + } + }, + "CertificateResourceCollection": { + "description": "Collection compose of certificate resources list and a possible link for next page.", + "type": "object", + "properties": { + "resources": { + "description": "The certificate resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CertificateResource" + } + }, + "nextLink": { + "description": "The link to next page of certificate list.", + "type": "string" + } + } + }, "NameAvailabilityParameters": { "description": "Name availability parameters payload", "required": [ @@ -2293,6 +2937,56 @@ }, "readOnly": true }, + "CustomDomainResource": { + "description": "Custom domain resource payload.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomDomainProperties", + "description": "Properties of the custom domain resource." + } + } + }, + "CustomDomainProperties": { + "description": "Custom domain of app resource payload.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of custom domain.", + "type": "string" + }, + "thumbprint": { + "description": "The thumbprint of bound ceritifcate.", + "type": "string" + } + } + }, + "CustomDomainResourceCollection": { + "description": "Collection compose of a custom domain resources list and a possible link for next page.", + "type": "object", + "properties": { + "resources": { + "description": "The custom domain resources list.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomainResource" + } + }, + "nextLink": { + "description": "The link to next page of custom domain list.", + "type": "string" + } + } + }, "DeploymentResource": { "description": "Deployment resource payload", "type": "object", @@ -2328,7 +3022,8 @@ "Creating", "Updating", "Succeeded", - "Failed" + "Failed", + "Deleting" ], "type": "string", "readOnly": true, @@ -2350,7 +3045,8 @@ "Failed", "Allocating", "Upgrading", - "Compiling" + "Compiling", + "Processing" ], "type": "string", "readOnly": true, @@ -2389,6 +3085,7 @@ "description": "Type of the source uploaded", "enum": [ "Jar", + "NetCoreZip", "Source" ], "type": "string", @@ -2435,6 +3132,10 @@ "description": "JVM parameter", "type": "string" }, + "netCoreMainEntryPath": { + "description": "The path to the .NET executable relative to zip root", + "type": "string" + }, "instanceCount": { "format": "int32", "description": "Instance count", @@ -2454,7 +3155,8 @@ "description": "Runtime version", "enum": [ "Java_8", - "Java_11" + "Java_11", + "NetCore_31" ], "type": "string", "x-ms-enum": { @@ -2724,6 +3426,123 @@ "displayName": { "description": "Localized friendly display name of the dimension", "type": "string" + }, + "toBeExportedForShoebox": { + "description": "Whether this dimension should be included for the Shoebox export scenario", + "type": "boolean" + } + } + }, + "AvailableRuntimeVersions": { + "type": "object", + "properties": { + "value": { + "description": "A list of all supported runtime versions.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SupportedRuntimeVersion" + }, + "readOnly": true + } + }, + "readOnly": true + }, + "SupportedRuntimeVersion": { + "description": "Supported deployment runtime version descriptor.", + "type": "object", + "properties": { + "value": { + "description": "The raw value which could be passed to deployment CRUD operations.", + "enum": [ + "Java_8", + "Java_11", + "NetCore_31" + ], + "type": "string", + "x-ms-enum": { + "name": "RuntimeVersion", + "modelAsString": true + } + }, + "platform": { + "description": "The platform of this runtime version (possible values: \"Java\" or \".NET\").", + "enum": [ + "Java", + ".NET Core" + ], + "type": "string", + "x-ms-enum": { + "name": "RuntimePlatform", + "modelAsString": true + } + }, + "version": { + "description": "The detailed version (major.minor) of the platform.", + "type": "string" + } + }, + "readOnly": true + }, + "ResourceTypeSkuCollection": { + "description": "Collection of supported Skus of Azure Spring Cloud resources", + "type": "object", + "properties": { + "value": { + "description": "Collection of supported Skus", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeSku" + } + } + } + }, + "ResourceTypeSku": { + "description": "Supported Skus of Azure Spring Cloud resources", + "type": "object", + "properties": { + "resourceType": { + "description": "Resource type", + "type": "string" + }, + "skus": { + "description": "Supported Skus", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SkuSetting" + } + } + } + }, + "SkuSetting": { + "description": "Supported Sku settings of Azure Spring Cloud", + "type": "object", + "properties": { + "name": { + "description": "Name of the Sku", + "type": "string" + }, + "tier": { + "description": "Tier of the Sku", + "type": "string" + }, + "locations": { + "description": "Locations of the Sku", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "requiredFeatures": { + "description": "Required features of the Sku", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } } } }, @@ -2839,4 +3658,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_CreateOrUpdateAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_CreateOrUpdateAsync.json new file mode 100644 index 000000000000..cf9dc9858e5f --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_CreateOrUpdateAsync.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "parameters": { + "properties": { + "keyvaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/myvault", + "keyvaultCertificateName": "mycert", + "vaultUri": "https://myvault.vault-int.azure-int.net" + }, + "type": "Microsoft.AppPlatform/Spring/certificates" + }, + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "certificateName": "mycertificate" + }, + "responses": { + "200": { + "body": { + "properties": { + "keyvaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/myvault", + "keyvaultCertificateName": "mycert", + "vaultUri": "https://myvault.vault-int.azure-int.net" + }, + "type": "Microsoft.AppPlatform/Spring/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate", + "name": "mycertificate" + } + } + } +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_DeleteAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_DeleteAsync.json new file mode 100644 index 000000000000..da353db0f803 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_DeleteAsync.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "parameters": { + "properties": { + "keyvaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/myvault", + "keyvaultCertificateName": "mycert", + "vaultUri": "https://myvault.vault-int.azure-int.net" + }, + "type": "Microsoft.AppPlatform/Spring/certificates" + }, + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "certificateName": "mycertificate" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_GetAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_GetAsync.json new file mode 100644 index 000000000000..cf9dc9858e5f --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_GetAsync.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "parameters": { + "properties": { + "keyvaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/myvault", + "keyvaultCertificateName": "mycert", + "vaultUri": "https://myvault.vault-int.azure-int.net" + }, + "type": "Microsoft.AppPlatform/Spring/certificates" + }, + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "certificateName": "mycertificate" + }, + "responses": { + "200": { + "body": { + "properties": { + "keyvaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/myvault", + "keyvaultCertificateName": "mycert", + "vaultUri": "https://myvault.vault-int.azure-int.net" + }, + "type": "Microsoft.AppPlatform/Spring/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate", + "name": "mycertificate" + } + } + } +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_ListAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_ListAsync.json new file mode 100644 index 000000000000..aacca4d81791 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Certificate_ListAsync.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myService" + }, + "responses": { + "200": { + "body": { + "resources": [ + { + "properties": { + "keyvaultResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.KeyVault/vaults/myvault", + "keyvaultCertificateName": "mycert", + "vaultUri": "https://myvault.vault-int.azure-int.net" + }, + "type": "Microsoft.AppPlatform/Spring/certificates", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate", + "name": "mycertificate" + } + ], + "nextLink": "Uri for next page" + } + } + } +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_CreateOrUpdateAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_CreateOrUpdateAsync.json new file mode 100644 index 000000000000..371f434441c8 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_CreateOrUpdateAsync.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "parameters": { + "properties": { + "name": "myDomain.com" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains" + }, + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "domainName": "myDomain.com" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "mydomain.com" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + } + } +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_DeleteAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_DeleteAsync.json new file mode 100644 index 000000000000..a5592546570b --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_DeleteAsync.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "parameters": { + "properties": { + "name": "myDomain.com" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains" + }, + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "domainName": "myDomain.com" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_GetAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_GetAsync.json new file mode 100644 index 000000000000..371f434441c8 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_GetAsync.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "parameters": { + "properties": { + "name": "myDomain.com" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains" + }, + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "domainName": "myDomain.com" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "mydomain.com" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + } + } +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_ListAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_ListAsync.json new file mode 100644 index 000000000000..8780759e8208 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_ListAsync.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp" + }, + "responses": { + "200": { + "body": { + "resources": [ + { + "properties": { + "name": "mydomain.com" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + ], + "nextLink": "Uri for next page" + } + } + } +} \ No newline at end of file diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_PatchAsync.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_PatchAsync.json new file mode 100644 index 000000000000..446b77333b5e --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_PatchAsync.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "parameters": { + "properties": { + "name": "myDomain.com", + "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains" + }, + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice", + "appName": "myapp", + "domainName": "myDomain.com" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "mydomain.com" + }, + "type": "Microsoft.AppPlatform/Spring/apps/domains", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp/domains/mydomain.com", + "name": "mydomain.com" + } + } + } +} \ No newline at end of file