From c57eb19baf7e9ae7984baa1ebae2308e2f540fcc Mon Sep 17 00:00:00 2001 From: Yazan Al-Alul Date: Fri, 25 Jan 2019 13:45:32 -0800 Subject: [PATCH 1/6] Adding swagger spec for healthcareapis resource manager and examples. --- .../examples/CheckNameAvailabilityPost.json | 19 + .../examples/OperationResultsGet.json | 28 + .../examples/OperationsList.json | 53 ++ .../examples/ServiceCreate.json | 81 ++ .../examples/ServiceDelete.json | 12 + .../examples/ServiceGet.json | 37 + .../examples/ServiceList.json | 40 + .../examples/ServiceListByResourceGroup.json | 41 + .../examples/ServicePatch.json | 49 + .../2018-08-20-preview/healthcare-apis.json | 882 ++++++++++++++++++ 10 files changed, 1242 insertions(+) create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/CheckNameAvailabilityPost.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/OperationResultsGet.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/OperationsList.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceDelete.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/CheckNameAvailabilityPost.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/CheckNameAvailabilityPost.json new file mode 100644 index 000000000000..849199f62f16 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/CheckNameAvailabilityPost.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2018-08-20-preview", + "subscriptionId": "subid", + "checkNameAvailabilityInputs": { + "type": "Microsoft.HealthcareApis/services", + "name": "serviceName" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Service name is not available." + } + } + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/OperationResultsGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/OperationResultsGet.json new file mode 100644 index 000000000000..60a271f13aac --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/OperationResultsGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2018-08-20-preview", + "subscriptionId": "subid", + "locationName": "westus", + "operationResultId": "exampleid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.HealthcareApis/locations/westus/operationresults/exampleid", + "name": "servicename", + "status": "Requested", + "startTime": "2019-01-21T06:03:30.2716301Z", + "properties": { + } + } + }, + "404": { + "body": { + "error": { + "code": "OperationResultNotFound", + "message": "The operation result was not found." + } + } + } + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/OperationsList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/OperationsList.json new file mode 100644 index 000000000000..194badfcaae5 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/OperationsList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2018-08-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HealthcareApis/services/read", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/services/write", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/services/delete", + "display": {}, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/locations/operationresults/read", + "display": { + "provider": "Microsoft.HealthcareApis", + "resource": "operationresults", + "operation": "read", + "description": "Get the status of an asynchronous operation" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.HealthcareApis/checkNameAvailability/post", + "display": {}, + "origin": "user" + }, + { + "name": "Microsoft.HealthcareApis/Operations/read", + "display": { + "provider": "Microsoft.HealthcareApis", + "resource": "operations", + "operation": "read", + "description": "Get the list of operations supported by this Resource Provider." + }, + "origin": "user,system" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json new file mode 100644 index 000000000000..76472282e583 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2018-08-20-preview", + "subscriptionId": "subid", + "serviceDescription": { + "location": "westus", + "tags": {}, + "kind": "fhir", + "sku": { + "name": "Standard" + }, + "properties": { + "accessControlSettings": { + "authority": "https://www.example.com", + "allowedOids": [ + "oid1", + "oid2" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir", + "sku": { + "name": "Standard" + }, + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessControlSettings": { + "authority": "https://www.example.com", + "allowedOids": [ + "oid1", + "oid2" + ] + }, + "cosmosDbSettings": { + "offerThroughput": 1000 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir", + "sku": { + "name": "Standard" + }, + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessControlSettings": { + "authority": "https://www.example.com", + "allowedOids": [ + "oid1", + "oid2" + ] + }, + "cosmosDbSettings": { + "offerThroughput": 1000 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceDelete.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceDelete.json new file mode 100644 index 000000000000..186c22363ac7 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2018-08-20-preview", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json new file mode 100644 index 000000000000..9d24b4a4a0c4 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2018-08-20-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir", + "sku": { + "name": "Standard" + }, + "etag": "etagvalue", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessControlSettings": { + "authority": "https://www.example.com", + "allowedOids": [ + "oid1", + "oid2" + ] + }, + "cosmosDbSettings": { + "offerThroughput": 1000 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json new file mode 100644 index 000000000000..7e7a75fe0714 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-08-20-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir", + "sku": { + "name": "Standard" + }, + "etag": "etag", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "accessControlSettings": { + "authority": "https://www.example.com", + "allowedOids": [ + "oid1", + "oid2" + ] + }, + "cosmosDbSettings": { + "offerThroughput": 1000 + } + } + } + ], + "nextLink": "https://host/subscriptions/subid/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d" + } + } + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json new file mode 100644 index 000000000000..e8e37bfcfeb6 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-08-20-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgname" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/dddb8dcb-effb-4290-bb47-ce1e8440c729", + "name": "service1", + "location": "westus", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir", + "sku": { + "name": "Standard" + }, + "tags": {}, + "etag": "etagvalue", + "properties": { + "provisioningState": "Creating", + "accessControlSettings": { + "authority": "https://www.example.com", + "allowedOids": [ + "oid1", + "oid2" + ] + }, + "cosmosDbSettings": { + "offerThroughput": 1000 + } + } + } + ], + "nextLink": "https://host/subscriptions/subid/resourceGroups/rgname/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d" + } + } + } +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json new file mode 100644 index 000000000000..0b42cf9f09c4 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "resourceName": "service1", + "resourceGroupName": "rg1", + "api-version": "2018-08-20-preview", + "subscriptionId": "subid", + "servicePatchDescription": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "sku": { + "name": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1", + "name": "service1", + "location": "West US", + "type": "Microsoft.HealthcareApis/services", + "kind": "fhir", + "sku": { + "name": "Standard" + }, + "etag": "etagvalue", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Creating", + "accessControlSettings": { + "authority": "https://www.example.com", + "allowedOids": [ + "oid1", + "oid2" + ] + }, + "cosmosDbSettings": { + "offerThroughput": 1000 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json new file mode 100644 index 000000000000..99ce7ac79a32 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json @@ -0,0 +1,882 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-08-20-preview", + "title": "HealthcareClient", + "description": "Use this API to manage Microsoft Healthcare services in your Azure subscription." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the metadata of a service instance.", + "operationId": "Service_Get", + "x-ms-examples": { + "ServiceGet": { + "$ref": "./examples/ServiceGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the service instance.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Resource" + ], + "description": "Create or update the metadata of a service instance.", + "operationId": "Service_CreateOrUpdate", + "x-ms-examples": { + "ServicePut": { + "$ref": "./examples/ServiceCreate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "serviceDescription", + "in": "body", + "description": "The service instance metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is being updated; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "201": { + "description": "Created - Put request accepted and a new resource was created; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Resource" + ], + "description": "Update the metadata of a service instance.", + "operationId": "Service_Update", + "x-ms-examples": { + "ServicePatch": { + "$ref": "./examples/ServicePatch.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "servicePatchDescription", + "in": "body", + "description": "The service instance metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesPatchDescription" + } + } + ], + "responses": { + "200": { + "description": "The tags for the resource were updated successfully.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Resource" + ], + "description": "Delete a service instance.", + "operationId": "Service_Delete", + "x-ms-examples": { + "ServiceDelete": { + "$ref": "./examples/ServiceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the service metadata in the service and the status of the delete operation is set to a completed state." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a subscription.", + "operationId": "Services_List", + "x-ms-examples": { + "ServiceList": { + "$ref": "./examples/ServiceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the subscription.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a resource group.", + "operationId": "Services_ListByResourceGroup", + "x-ms-examples": { + "ServiceListByResourceGroup": { + "$ref": "./examples/ServiceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the resource group.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/providers/Microsoft.HealthcareApis/operations": { + "get": { + "tags": [ + "Proxy" + ], + "description": "Lists all of the available Healthcare service REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability": { + "post": { + "tags": [ + "Proxy" + ], + "description": "Check if a service instance name is available.", + "operationId": "Service_CheckNameAvailability", + "x-ms-examples": { + "ServiceList": { + "$ref": "./examples/CheckNameAvailabilityPost.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "checkNameAvailabilityInputs", + "in": "body", + "description": "Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/ServicesNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the operation result for a long running operation.", + "operationId": "OperationResults_Get", + "x-ms-examples": { + "OperationResultsGet": { + "$ref": "./examples/OperationResultsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationName" + }, + { + "$ref": "#/parameters/operationResultId" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the operation result.", + "schema": { + "$ref": "#/definitions/OperationResultsDescription" + } + }, + "404": { + "description": "No operation result was found matching operationResultId.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "ServicesProperties": { + "description": "The properties of a service instance.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "enum": [ + "Deleting", + "Succeeded", + "Creating", + "Accepted", + "Verifying", + "Updating", + "Failed", + "Canceled", + "Deprovisioned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "accessControlSettings": { + "$ref": "#/definitions/ServiceAccessControlSettingsInfo", + "description": "The access control settings of the service instance." + }, + "cosmosDbSettings": { + "$ref": "#/definitions/ServiceCosmosDbSettingsInfo", + "description": "The settings for the Cosmos DB database backing the service." + } + }, + "required": [ + "accessControlSettings" + ] + }, + "ServiceAccessControlSettingsInfo": { + "description": "The access control settings of the service instance.", + "type": "object", + "properties": { + "authority": { + "description": "Url to the authentication authority.", + "type": "string" + }, + "allowedOids": { + "description": "List of object IDs that are allowed to access the FHIR service.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "authority", + "allowedOids" + ] + }, + "ServiceCosmosDbSettingsInfo": { + "description": "The settings for the Cosmos DB database backing the service.", + "type": "object", + "properties": { + "offerThroughput": { + "type": "integer", + "description": "The provisioned throughput for the backing database.", + "readOnly": false + } + } + }, + "ServicesSkuInfo": { + "description": "Information about the SKU of the service instance.", + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU.", + "enum": [ + "Standard" + ], + "type": "string", + "x-ms-enum": { + "name": "ServicesSku", + "modelAsString": true + } + } + }, + "required": [ + "name" + ] + }, + "ServicesDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "description": "The common properties of a service.", + "$ref": "#/definitions/ServicesProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ] + }, + "ServicesPatchDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "tags": { + "description": "Instance tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "allOf": { + "description": "Sku details of a service.", + "$ref": "#/definitions/ServicesSkuInfo" + } + } + }, + "Resource": { + "description": "The common properties of a service.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,21}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "kind": { + "readOnly": false, + "type": "string", + "description": "The kind of the service. Valid values are: fhir." + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "sku": { + "description": "A valid instance SKU.", + "$ref": "#/definitions/ServicesSkuInfo" + }, + "etag": { + "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", + "type": "string" + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "error": { + "description": "Object containing error details.", + "$ref": "#/definitions/ErrorDetailsInternal" + } + } + }, + "ErrorDetailsInternal": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "ServicesDescriptionListResult": { + "description": "A list of service description objects with a next link.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of service description objects.", + "type": "string" + }, + "value": { + "description": "A list of service description objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServicesDescription" + } + } + } + }, + "OperationListResult": { + "description": "A list of service operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of service description objects.", + "type": "string" + }, + "value": { + "description": "A list of service operations supported by the Microsoft.HealthcareApis resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "Service REST API operation.", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "origin": { + "readOnly": true, + "type": "string", + "description": "Default value is 'user,system'." + }, + "display": { + "description": "The information displayed about the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.HealthcareApis" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: Services" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the service instance to check.", + "type": "string" + }, + "type": { + "description": "The fully qualified resource type which includes provider namespace.", + "type": "string" + } + }, + "required": [ + "name", + "type" + ] + }, + "ServicesNameAvailabilityInfo": { + "description": "The properties indicating whether a given service name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ServiceNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + }, + "OperationResultsDescription": { + "description": "The properties indicating the operation result of an operation on a service.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the operation returned.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the operation result.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The status of the operation being performed.", + "enum": [ + "Canceled", + "Succeeded", + "Failed", + "Requested", + "Running" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "OperationResultStatus", + "modelAsString": true + } + }, + "startTime": { + "description": "The time that the operation was started.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "description": "Additional properties of the operation result." + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string", + "format": "uuid" + }, + "api-version": { + "name": "api-version", + "enum": [ + "2018-08-20-preview" + ], + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string", + "minLength": 10 + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the service instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the service instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 + }, + "locationName": { + "name": "locationName", + "in": "path", + "description": "The location of the operation.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "operationResultId": { + "name": "operationResultId", + "in": "path", + "description": "The ID of the operation result to get.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file From bffd493d3c21809d356c251f46d6588cde4b2ab8 Mon Sep 17 00:00:00 2001 From: Yazan Al-Alul Date: Sun, 27 Jan 2019 15:02:55 -0800 Subject: [PATCH 2/6] Change accessControlSettings to accessPolicies. --- .../examples/ServiceCreate.json | 45 ++++++++++--------- .../examples/ServiceGet.json | 15 ++++--- .../examples/ServiceList.json | 15 ++++--- .../examples/ServiceListByResourceGroup.json | 15 ++++--- .../examples/ServicePatch.json | 15 ++++--- .../2018-08-20-preview/healthcare-apis.json | 38 ++++++++-------- 6 files changed, 74 insertions(+), 69 deletions(-) diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json index 76472282e583..420bf9be15c9 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json @@ -12,13 +12,14 @@ "name": "Standard" }, "properties": { - "accessControlSettings": { - "authority": "https://www.example.com", - "allowedOids": [ - "oid1", - "oid2" - ] - } + "accessPolicies": [ + { + "objectId": "oid1" + }, + { + "objectId": "oid2" + } + ] } } }, @@ -37,13 +38,14 @@ "tags": {}, "properties": { "provisioningState": "Creating", - "accessControlSettings": { - "authority": "https://www.example.com", - "allowedOids": [ - "oid1", - "oid2" - ] - }, + "accessPolicies": [ + { + "objectId": "oid1" + }, + { + "objectId": "oid2" + } + ], "cosmosDbSettings": { "offerThroughput": 1000 } @@ -64,13 +66,14 @@ "tags": {}, "properties": { "provisioningState": "Creating", - "accessControlSettings": { - "authority": "https://www.example.com", - "allowedOids": [ - "oid1", - "oid2" - ] - }, + "accessPolicies": [ + { + "objectId": "oid1" + }, + { + "objectId": "oid2" + } + ], "cosmosDbSettings": { "offerThroughput": 1000 } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json index 9d24b4a4a0c4..ce84ef2e385f 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json @@ -20,13 +20,14 @@ "tags": {}, "properties": { "provisioningState": "Creating", - "accessControlSettings": { - "authority": "https://www.example.com", - "allowedOids": [ - "oid1", - "oid2" - ] - }, + "accessPolicies": [ + { + "objectId": "oid1" + }, + { + "objectId": "oid2" + } + ], "cosmosDbSettings": { "offerThroughput": 1000 } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json index 7e7a75fe0714..dd54c65068dd 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json @@ -20,13 +20,14 @@ "tags": {}, "properties": { "provisioningState": "Creating", - "accessControlSettings": { - "authority": "https://www.example.com", - "allowedOids": [ - "oid1", - "oid2" - ] - }, + "accessPolicies": [ + { + "objectId": "oid1" + }, + { + "objectId": "oid2" + } + ], "cosmosDbSettings": { "offerThroughput": 1000 } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json index e8e37bfcfeb6..7261a45fec96 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json @@ -21,13 +21,14 @@ "etag": "etagvalue", "properties": { "provisioningState": "Creating", - "accessControlSettings": { - "authority": "https://www.example.com", - "allowedOids": [ - "oid1", - "oid2" - ] - }, + "accessPolicies": [ + { + "objectId": "oid1" + }, + { + "objectId": "oid2" + } + ], "cosmosDbSettings": { "offerThroughput": 1000 } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json index 0b42cf9f09c4..55d2aac488c6 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json @@ -32,13 +32,14 @@ }, "properties": { "provisioningState": "Creating", - "accessControlSettings": { - "authority": "https://www.example.com", - "allowedOids": [ - "oid1", - "oid2" - ] - }, + "accessPolicies": [ + { + "objectId": "oid1" + }, + { + "objectId": "oid2" + } + ], "cosmosDbSettings": { "offerThroughput": 1000 } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json index 99ce7ac79a32..d45b368f144e 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json @@ -215,7 +215,7 @@ "description": "Accepted - Delete request accepted; the operation will complete asynchronously." }, "204": { - "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the service metadata in the service and the status of the delete operation is set to a completed state." + "description": "The resource does not exist." }, "default": { "description": "DefaultErrorResponse", @@ -467,9 +467,9 @@ "modelAsString": true } }, - "accessControlSettings": { - "$ref": "#/definitions/ServiceAccessControlSettingsInfo", - "description": "The access control settings of the service instance." + "accessPolicies": { + "$ref": "#/definitions/ServiceAccessPoliciesInfo", + "description": "The access policies of the service instance." }, "cosmosDbSettings": { "$ref": "#/definitions/ServiceCosmosDbSettingsInfo", @@ -477,28 +477,26 @@ } }, "required": [ - "accessControlSettings" + "accessPolicies" ] }, - "ServiceAccessControlSettingsInfo": { - "description": "The access control settings of the service instance.", - "type": "object", - "properties": { - "authority": { - "description": "Url to the authentication authority.", + "ServiceAccessPoliciesInfo": { + "description": "The access policies of the service instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAccessPolicyEntry" + } + }, + "ServiceAccessPolicyEntry": { + "description": "An access policy entry.", + "properties":{ + "objectId": { + "description": "An object ID that is allowed access to the FHIR service.", "type": "string" - }, - "allowedOids": { - "description": "List of object IDs that are allowed to access the FHIR service.", - "type": "array", - "items": { - "type": "string" - } } }, "required": [ - "authority", - "allowedOids" + "objectId" ] }, "ServiceCosmosDbSettingsInfo": { From 537ce30d37fe668419690dd74aa02193e9ab67be Mon Sep 17 00:00:00 2001 From: Yazan Al-Alul Date: Tue, 29 Jan 2019 11:09:33 -0800 Subject: [PATCH 3/6] Remove Sku and change cosmosDbSettings to cosmosDbConfiguration --- .../examples/ServiceCreate.json | 13 +------ .../examples/ServiceGet.json | 5 +-- .../examples/ServiceList.json | 5 +-- .../examples/ServiceListByResourceGroup.json | 5 +-- .../examples/ServicePatch.json | 8 +--- .../2018-08-20-preview/healthcare-apis.json | 37 ++----------------- 6 files changed, 9 insertions(+), 64 deletions(-) diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json index 420bf9be15c9..5ab984814627 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json @@ -8,9 +8,6 @@ "location": "westus", "tags": {}, "kind": "fhir", - "sku": { - "name": "Standard" - }, "properties": { "accessPolicies": [ { @@ -31,9 +28,6 @@ "location": "West US", "type": "Microsoft.HealthcareApis/services", "kind": "fhir", - "sku": { - "name": "Standard" - }, "etag": "etagvalue", "tags": {}, "properties": { @@ -46,7 +40,7 @@ "objectId": "oid2" } ], - "cosmosDbSettings": { + "cosmosDbConfiguration": { "offerThroughput": 1000 } } @@ -59,9 +53,6 @@ "location": "West US", "type": "Microsoft.HealthcareApis/services", "kind": "fhir", - "sku": { - "name": "Standard" - }, "etag": "etagvalue", "tags": {}, "properties": { @@ -74,7 +65,7 @@ "objectId": "oid2" } ], - "cosmosDbSettings": { + "cosmosDbConfiguration": { "offerThroughput": 1000 } } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json index ce84ef2e385f..671b4c7df947 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json @@ -13,9 +13,6 @@ "location": "West US", "type": "Microsoft.HealthcareApis/services", "kind": "fhir", - "sku": { - "name": "Standard" - }, "etag": "etagvalue", "tags": {}, "properties": { @@ -28,7 +25,7 @@ "objectId": "oid2" } ], - "cosmosDbSettings": { + "cosmosDbConfiguration": { "offerThroughput": 1000 } } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json index dd54c65068dd..9eecd6bf91bb 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json @@ -13,9 +13,6 @@ "location": "West US", "type": "Microsoft.HealthcareApis/services", "kind": "fhir", - "sku": { - "name": "Standard" - }, "etag": "etag", "tags": {}, "properties": { @@ -28,7 +25,7 @@ "objectId": "oid2" } ], - "cosmosDbSettings": { + "cosmosDbConfiguration": { "offerThroughput": 1000 } } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json index 7261a45fec96..ee9759612053 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json @@ -14,9 +14,6 @@ "location": "westus", "type": "Microsoft.HealthcareApis/services", "kind": "fhir", - "sku": { - "name": "Standard" - }, "tags": {}, "etag": "etagvalue", "properties": { @@ -29,7 +26,7 @@ "objectId": "oid2" } ], - "cosmosDbSettings": { + "cosmosDbConfiguration": { "offerThroughput": 1000 } } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json index 55d2aac488c6..72e54b97fed7 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json @@ -8,9 +8,6 @@ "tags": { "tag1": "value1", "tag2": "value2" - }, - "sku": { - "name": "Standard" } } }, @@ -22,9 +19,6 @@ "location": "West US", "type": "Microsoft.HealthcareApis/services", "kind": "fhir", - "sku": { - "name": "Standard" - }, "etag": "etagvalue", "tags": { "tag1": "value1", @@ -40,7 +34,7 @@ "objectId": "oid2" } ], - "cosmosDbSettings": { + "cosmosDbConfiguration": { "offerThroughput": 1000 } } diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json index d45b368f144e..ec8f3067e7b3 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json @@ -471,8 +471,8 @@ "$ref": "#/definitions/ServiceAccessPoliciesInfo", "description": "The access policies of the service instance." }, - "cosmosDbSettings": { - "$ref": "#/definitions/ServiceCosmosDbSettingsInfo", + "cosmosDbConfiguration": { + "$ref": "#/definitions/ServiceCosmosDbConfigurationInfo", "description": "The settings for the Cosmos DB database backing the service." } }, @@ -499,7 +499,7 @@ "objectId" ] }, - "ServiceCosmosDbSettingsInfo": { + "ServiceCosmosDbConfigurationInfo": { "description": "The settings for the Cosmos DB database backing the service.", "type": "object", "properties": { @@ -510,26 +510,6 @@ } } }, - "ServicesSkuInfo": { - "description": "Information about the SKU of the service instance.", - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU.", - "enum": [ - "Standard" - ], - "type": "string", - "x-ms-enum": { - "name": "ServicesSku", - "modelAsString": true - } - } - }, - "required": [ - "name" - ] - }, "ServicesDescription": { "description": "The description of the service.", "type": "object", @@ -544,9 +524,6 @@ { "$ref": "#/definitions/Resource" } - ], - "required": [ - "sku" ] }, "ServicesPatchDescription": { @@ -559,10 +536,6 @@ "additionalProperties": { "type": "string" } - }, - "allOf": { - "description": "Sku details of a service.", - "$ref": "#/definitions/ServicesSkuInfo" } } }, @@ -605,10 +578,6 @@ }, "description": "The resource tags." }, - "sku": { - "description": "A valid instance SKU.", - "$ref": "#/definitions/ServicesSkuInfo" - }, "etag": { "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", "type": "string" From 5220cd0523b36a1ddc3bc207f6e6f708f5f9d09c Mon Sep 17 00:00:00 2001 From: Yazan Al-Alul Date: Wed, 6 Mar 2019 16:01:42 -0800 Subject: [PATCH 4/6] Updates and adding .md files --- .../examples/MoveResourcesPost.json | 17 + .../examples/ServiceCreate.json | 14 +- .../examples/ServiceGet.json | 6 +- .../examples/ServiceList.json | 6 +- .../examples/ServiceListByResourceGroup.json | 4 +- .../examples/ServicePatch.json | 6 +- .../2018-08-20-preview/healthcare-apis.json | 1721 +++++++++-------- .../resource-manager/readme.go.md | 25 + .../healthcareapis/resource-manager/readme.md | 128 ++ .../resource-manager/readme.nodejs.md | 14 + .../resource-manager/readme.typescript.md | 12 + 11 files changed, 1141 insertions(+), 812 deletions(-) create mode 100644 specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/MoveResourcesPost.json create mode 100644 specification/healthcareapis/resource-manager/readme.go.md create mode 100644 specification/healthcareapis/resource-manager/readme.md create mode 100644 specification/healthcareapis/resource-manager/readme.nodejs.md create mode 100644 specification/healthcareapis/resource-manager/readme.typescript.md diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/MoveResourcesPost.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/MoveResourcesPost.json new file mode 100644 index 000000000000..d666b3160f67 --- /dev/null +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/MoveResourcesPost.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2018-08-20-preview", + "subscriptionId": "subid", + "resourceGroupName": "resourceGroup", + "moveResourcesInputs": { + "targetSubscriptionId": "newSubscriptionId", + "targetResourceGroupName": "newResourceGroup", + "resourceIdsToMove": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1" + ] + } + }, + "responses": { + "202": { } + } +} \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json index 5ab984814627..f64fb2404040 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceCreate.json @@ -11,10 +11,10 @@ "properties": { "accessPolicies": [ { - "objectId": "oid1" + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" }, { - "objectId": "oid2" + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" } ] } @@ -34,10 +34,10 @@ "provisioningState": "Creating", "accessPolicies": [ { - "objectId": "oid1" + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" }, { - "objectId": "oid2" + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" } ], "cosmosDbConfiguration": { @@ -59,10 +59,10 @@ "provisioningState": "Creating", "accessPolicies": [ { - "objectId": "oid1" + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" }, { - "objectId": "oid2" + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" } ], "cosmosDbConfiguration": { @@ -72,4 +72,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json index 671b4c7df947..cd19a503e675 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceGet.json @@ -19,10 +19,10 @@ "provisioningState": "Creating", "accessPolicies": [ { - "objectId": "oid1" + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" }, { - "objectId": "oid2" + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" } ], "cosmosDbConfiguration": { @@ -32,4 +32,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json index 9eecd6bf91bb..1bb954eb9eaa 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceList.json @@ -19,10 +19,10 @@ "provisioningState": "Creating", "accessPolicies": [ { - "objectId": "oid1" + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" }, { - "objectId": "oid2" + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" } ], "cosmosDbConfiguration": { @@ -35,4 +35,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json index ee9759612053..d814b8550a41 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServiceListByResourceGroup.json @@ -20,10 +20,10 @@ "provisioningState": "Creating", "accessPolicies": [ { - "objectId": "oid1" + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" }, { - "objectId": "oid2" + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" } ], "cosmosDbConfiguration": { diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json index 72e54b97fed7..ffd7c2d7b0bb 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/examples/ServicePatch.json @@ -28,10 +28,10 @@ "provisioningState": "Creating", "accessPolicies": [ { - "objectId": "oid1" + "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47" }, { - "objectId": "oid2" + "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f" } ], "cosmosDbConfiguration": { @@ -41,4 +41,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json index ec8f3067e7b3..57eb15eefb33 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json @@ -1,849 +1,982 @@ { "swagger": "2.0", "info": { - "version": "2018-08-20-preview", - "title": "HealthcareClient", - "description": "Use this API to manage Microsoft Healthcare services in your Azure subscription." + "version": "2018-08-20-preview", + "title": "HealthcareClient", + "description": "Use this API to manage Microsoft Healthcare services in your Azure subscription." }, "host": "management.azure.com", "schemes": [ - "https" + "https" ], "consumes": [ - "application/json" + "application/json" ], "produces": [ - "application/json" + "application/json" ], "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } + { + "azure_auth": [ + "user_impersonation" + ] + } ], "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } } - } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}": { - "get": { - "tags": [ - "Resource" - ], - "description": "Get the metadata of a service instance.", - "operationId": "Service_Get", - "x-ms-examples": { - "ServiceGet": { - "$ref": "./examples/ServiceGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/resourceName" - } - ], - "responses": { - "200": { - "description": "The body contains all of the properties of the service instance.", - "schema": { - "$ref": "#/definitions/ServicesDescription" - } - }, - "default": { - "description": "Default error response", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the metadata of a service instance.", + "operationId": "Service_Get", + "x-ms-examples": { + "ServiceGet": { + "$ref": "./examples/ServiceGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the service instance.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Resource" + ], + "description": "Create or update the metadata of a service instance.", + "operationId": "Service_CreateOrUpdate", + "x-ms-examples": { + "ServicePut": { + "$ref": "./examples/ServiceCreate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "serviceDescription", + "in": "body", + "description": "The service instance metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + } + ], + "responses": { + "200": { + "description": "Updated - Put request accepted and an existing resource is being updated; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "201": { + "description": "Created - Put request accepted and a new resource was created; the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "Resource" + ], + "description": "Update the metadata of a service instance.", + "operationId": "Service_Update", + "x-ms-examples": { + "ServicePatch": { + "$ref": "./examples/ServicePatch.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "servicePatchDescription", + "in": "body", + "description": "The service instance metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/ServicesPatchDescription" + } + } + ], + "responses": { + "200": { + "description": "The tags for the resource were updated successfully.", + "schema": { + "$ref": "#/definitions/ServicesDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Resource" + ], + "description": "Delete a service instance.", + "operationId": "Service_Delete", + "x-ms-examples": { + "ServiceDelete": { + "$ref": "./examples/ServiceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "Accepted - Delete request accepted; the operation will complete asynchronously." + }, + "204": { + "description": "The resource does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } } - }, - "deprecated": false }, - "put": { - "tags": [ - "Resource" - ], - "description": "Create or update the metadata of a service instance.", - "operationId": "Service_CreateOrUpdate", - "x-ms-examples": { - "ServicePut": { - "$ref": "./examples/ServiceCreate.json" + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a subscription.", + "operationId": "Services_List", + "x-ms-examples": { + "ServiceList": { + "$ref": "./examples/ServiceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the subscription.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false } - }, - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/resourceName" - }, - { - "name": "serviceDescription", - "in": "body", - "description": "The service instance metadata.", - "required": true, - "schema": { - "$ref": "#/definitions/ServicesDescription" - } - } - ], - "responses": { - "200": { - "description": "Updated - Put request accepted and an existing resource is being updated; the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ServicesDescription" - } - }, - "201": { - "description": "Created - Put request accepted and a new resource was created; the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/ServicesDescription" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false }, - "patch": { - "tags": [ - "Resource" - ], - "description": "Update the metadata of a service instance.", - "operationId": "Service_Update", - "x-ms-examples": { - "ServicePatch": { - "$ref": "./examples/ServicePatch.json" - } - }, - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/resourceName" - }, - { - "name": "servicePatchDescription", - "in": "body", - "description": "The service instance metadata and security metadata.", - "required": true, - "schema": { - "$ref": "#/definitions/ServicesPatchDescription" - } + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services": { + "get": { + "tags": [ + "Collection" + ], + "description": "Get all the service instances in a resource group.", + "operationId": "Services_ListByResourceGroup", + "x-ms-examples": { + "ServiceListByResourceGroup": { + "$ref": "./examples/ServiceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the resource group.", + "schema": { + "$ref": "#/definitions/ServicesDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false } - ], - "responses": { - "200": { - "description": "The tags for the resource were updated successfully.", - "schema": { - "$ref": "#/definitions/ServicesDescription" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "deprecated": false }, - "delete": { - "tags": [ - "Resource" - ], - "description": "Delete a service instance.", - "operationId": "Service_Delete", - "x-ms-examples": { - "ServiceDelete": { - "$ref": "./examples/ServiceDelete.json" - } - }, - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/resourceName" + "/providers/Microsoft.HealthcareApis/operations": { + "get": { + "tags": [ + "Proxy" + ], + "description": "Lists all of the available Healthcare service REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false } - ], - "responses": { - "202": { - "description": "Accepted - Delete request accepted; the operation will complete asynchronously." - }, - "204": { - "description": "The resource does not exist." - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services": { - "get": { - "tags": [ - "Collection" - ], - "description": "Get all the service instances in a subscription.", - "operationId": "Services_List", - "x-ms-examples": { - "ServiceList": { - "$ref": "./examples/ServiceList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the subscription.", - "schema": { - "$ref": "#/definitions/ServicesDescriptionListResult" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability": { + "post": { + "tags": [ + "Proxy" + ], + "description": "Check if a service instance name is available.", + "operationId": "Service_CheckNameAvailability", + "x-ms-examples": { + "ServiceList": { + "$ref": "./examples/CheckNameAvailabilityPost.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "checkNameAvailabilityInputs", + "in": "body", + "description": "Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/ServicesNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services": { - "get": { - "tags": [ - "Collection" - ], - "description": "Get all the service instances in a resource group.", - "operationId": "Services_ListByResourceGroup", - "x-ms-examples": { - "ServiceListByResourceGroup": { - "$ref": "./examples/ServiceListByResourceGroup.json" + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/moveResources": { + "post": { + "tags": [ + "Proxy" + ], + "description": "Moves resources to another subscription and/or resource group.", + "operationId": "Service_MoveResources", + "x-ms-examples": { + "ServiceList": { + "$ref": "./examples/MoveResourcesPost.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "moveResourcesInputs", + "in": "body", + "description": "Set the move resource structure to the name of the service instance to check.", + "required": true, + "schema": { + "$ref": "#/definitions/MoveResourcesParameters" + } + } + ], + "responses": { + "202": { + "description": "Accepted - Move request accepted; the operation will complete asynchronously." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the operation result for a long running operation.", + "operationId": "OperationResults_Get", + "x-ms-examples": { + "OperationResultsGet": { + "$ref": "./examples/OperationResultsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationName" + }, + { + "$ref": "#/parameters/operationResultId" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the operation result.", + "schema": { + "$ref": "#/definitions/OperationResultsDescription" + } + }, + "404": { + "description": "No operation result was found matching operationResultId.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the resource group.", - "schema": { - "$ref": "#/definitions/ServicesDescriptionListResult" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/moveResourcesStatus/{operationResultId}": { + "get": { + "tags": [ + "Resource" + ], + "description": "Get the operation result for a long running move operation.", + "operationId": "MoveResourcesStatus_Get", + "x-ms-examples": { + "OperationResultsGet": { + "$ref": "./examples/OperationResultsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationName" + }, + { + "$ref": "#/parameters/operationResultId" + } + ], + "responses": { + "200": { + "description": "The body contains all of the properties of the operation result.", + "schema": { + "$ref": "#/definitions/OperationResultsDescription" + } + }, + "404": { + "description": "No operation result was found matching operationResultId.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false } - }, - "deprecated": false } - }, - "/providers/Microsoft.HealthcareApis/operations": { - "get": { - "tags": [ - "Proxy" - ], - "description": "Lists all of the available Healthcare service REST API operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "OperationsList": { - "$ref": "./examples/OperationsList.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } + }, + "definitions": { + "ServicesProperties": { + "description": "The properties of a service instance.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state.", + "enum": [ + "Deleting", + "Succeeded", + "Creating", + "Accepted", + "Verifying", + "Updating", + "Failed", + "Canceled", + "Deprovisioned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "accessPolicies": { + "$ref": "#/definitions/ServiceAccessPoliciesInfo", + "description": "The access policies of the service instance." + }, + "cosmosDbConfiguration": { + "$ref": "#/definitions/ServiceCosmosDbConfigurationInfo", + "description": "The settings for the Cosmos DB database backing the service." + } + }, + "required": [ + "accessPolicies" + ] + }, + "ServiceAccessPoliciesInfo": { + "description": "The access policies of the service instance.", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/definitions/ServiceAccessPolicyEntry" } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/checkNameAvailability": { - "post": { - "tags": [ - "Proxy" - ], - "description": "Check if a service instance name is available.", - "operationId": "Service_CheckNameAvailability", - "x-ms-examples": { - "ServiceList": { - "$ref": "./examples/CheckNameAvailabilityPost.json" + }, + "ServiceAccessPolicyEntry": { + "description": "An access policy entry.", + "properties": { + "objectId": { + "description": "An object ID that is allowed access to the FHIR service.", + "type": "string", + "pattern": "^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$" + } + }, + "required": [ + "objectId" + ] + }, + "ServiceCosmosDbConfigurationInfo": { + "description": "The settings for the Cosmos DB database backing the service.", + "type": "object", + "properties": { + "offerThroughput": { + "type": "integer", + "description": "The provisioned throughput for the backing database.", + "readOnly": false + } } - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "checkNameAvailabilityInputs", - "in": "body", - "description": "Set the name parameter in the CheckNameAvailabilityParameters structure to the name of the service instance to check.", - "required": true, - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityParameters" - } + }, + "ServicesDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": false, + "description": "The common properties of a service.", + "$ref": "#/definitions/ServicesProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ServicesPatchDescription": { + "description": "The description of the service.", + "type": "object", + "properties": { + "tags": { + "description": "Instance tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } } - ], - "responses": { - "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the service name is available. If the name is not available, the body contains the reason.", - "schema": { - "$ref": "#/definitions/ServicesNameAvailabilityInfo" - } - }, - "default": { - "description": "DefaultErrorResponse", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } + }, + "Resource": { + "description": "The common properties of a service.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "kind": { + "readOnly": false, + "type": "string", + "description": "The kind of the service. Valid values are: fhir.", + "enum": [ + "fhir" + ], + "x-ms-enum":{ + "name": "kind", + "modelAsString": false + } + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "etag": { + "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", + "type": "string" + } + }, + "x-ms-azure-resource": true, + "required": [ + "location", + "kind" + ] + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "error": { + "description": "Object containing error details.", + "$ref": "#/definitions/ErrorDetailsInternal" + } } - }, - "deprecated": false - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/locations/{locationName}/operationresults/{operationResultId}": { - "get": { - "tags": [ - "Resource" - ], - "description": "Get the operation result for a long running operation.", - "operationId": "OperationResults_Get", - "x-ms-examples": { - "OperationResultsGet": { - "$ref": "./examples/OperationResultsGet.json" + }, + "ErrorDetailsInternal": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } } - }, - "parameters": [ - { - "$ref": "#/parameters/api-version" - }, - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/locationName" - }, - { - "$ref": "#/parameters/operationResultId" + }, + "ServicesDescriptionListResult": { + "description": "A list of service description objects with a next link.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of service description objects.", + "type": "string" + }, + "value": { + "description": "A list of service description objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServicesDescription" + } + } } - ], - "responses": { - "200": { - "description": "The body contains all of the properties of the operation result.", - "schema": { - "$ref": "#/definitions/OperationResultsDescription" - } - }, - "404": { - "description": "No operation result was found matching operationResultId.", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } - }, - "default": { - "description": "Default error response", - "schema": { - "$ref": "#/definitions/ErrorDetails" - } + }, + "OperationListResult": { + "description": "A list of service operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of service description objects.", + "type": "string" + }, + "value": { + "description": "A list of service operations supported by the Microsoft.HealthcareApis resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + } } - }, - "deprecated": false - } - } - }, - "definitions": { - "ServicesProperties": { - "description": "The properties of a service instance.", - "type": "object", - "properties": { - "provisioningState": { - "description": "The provisioning state.", - "enum": [ - "Deleting", - "Succeeded", - "Creating", - "Accepted", - "Verifying", - "Updating", - "Failed", - "Canceled", - "Deprovisioned" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true + }, + "Operation": { + "description": "Service REST API operation.", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "origin": { + "readOnly": true, + "type": "string", + "description": "Default value is 'user,system'." + }, + "display": { + "description": "The information displayed about the operation.", + "$ref": "#/definitions/OperationDisplay" + } } - }, - "accessPolicies": { - "$ref": "#/definitions/ServiceAccessPoliciesInfo", - "description": "The access policies of the service instance." - }, - "cosmosDbConfiguration": { - "$ref": "#/definitions/ServiceCosmosDbConfigurationInfo", - "description": "The settings for the Cosmos DB database backing the service." - } }, - "required": [ - "accessPolicies" - ] - }, - "ServiceAccessPoliciesInfo": { - "description": "The access policies of the service instance.", - "type": "array", - "items": { - "$ref": "#/definitions/ServiceAccessPolicyEntry" - } - }, - "ServiceAccessPolicyEntry": { - "description": "An access policy entry.", - "properties":{ - "objectId": { - "description": "An object ID that is allowed access to the FHIR service.", - "type": "string" - } + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.HealthcareApis" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: Services" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Friendly description for the operation," + } + } }, - "required": [ - "objectId" - ] - }, - "ServiceCosmosDbConfigurationInfo": { - "description": "The settings for the Cosmos DB database backing the service.", - "type": "object", - "properties": { - "offerThroughput": { - "type": "integer", - "description": "The provisioned throughput for the backing database.", - "readOnly": false - } - } - }, - "ServicesDescription": { - "description": "The description of the service.", - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": false, - "description": "The common properties of a service.", - "$ref": "#/definitions/ServicesProperties" - } + "CheckNameAvailabilityParameters": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the service instance to check.", + "type": "string" + }, + "type": { + "description": "The fully qualified resource type which includes provider namespace.", + "type": "string" + } + }, + "required": [ + "name", + "type" + ] }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ServicesPatchDescription": { - "description": "The description of the service.", - "type": "object", - "properties": { - "tags": { - "description": "Instance tags", + "ServicesNameAvailabilityInfo": { + "description": "The properties indicating whether a given service name is available.", "type": "object", - "additionalProperties": { - "type": "string" + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ServiceNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } } - } - } - }, - "Resource": { - "description": "The common properties of a service.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "The resource identifier." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The resource name.", - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,21}[a-zA-Z0-9]$" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The resource type." - }, - "kind": { - "readOnly": false, - "type": "string", - "description": "The kind of the service. Valid values are: fhir." - }, - "location": { - "type": "string", - "description": "The resource location.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "tags": { + }, + "MoveResourcesParameters": { + "description": "Input values.", "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The resource tags." - }, - "etag": { - "description": "An etag associated with the resource, used for optimistic concurrency when editing it.", - "type": "string" - } + "properties": { + "targetSubscriptionId": { + "description": "The target subscription to move resources to.", + "type": "string" + }, + "targetResourceGroupName": { + "description": "The target resource group to move resources to.", + "type": "string" + }, + "resourceIdsToMove": { + "description": "The list of resources to move.", + "type": "array", + "minItems": 1, + "maxItems": 250, + "items": { + "type": "string" + } + } + }, + "required": [ + "targetSubscriptionId", + "targetResourceGroupName", + "resourceIdsToMove" + ] }, - "x-ms-azure-resource": true, - "required": [ - "location" - ] - }, - "ErrorDetails": { - "description": "Error details.", - "type": "object", - "properties": { - "error": { - "description": "Object containing error details.", - "$ref": "#/definitions/ErrorDetailsInternal" - } - } - }, - "ErrorDetailsInternal": { - "description": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "The error message.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } - }, - "ServicesDescriptionListResult": { - "description": "A list of service description objects with a next link.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of service description objects.", - "type": "string" - }, - "value": { - "description": "A list of service description objects.", - "type": "array", - "items": { - "$ref": "#/definitions/ServicesDescription" - } - } - } - }, - "OperationListResult": { - "description": "A list of service operations. It contains a list of operations and a URL link to get the next set of results.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of service description objects.", - "type": "string" - }, - "value": { - "description": "A list of service operations supported by the Microsoft.HealthcareApis resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" + "OperationResultsDescription": { + "description": "The properties indicating the operation result of an operation on a service.", + "type": "object", + "properties": { + "id": { + "description": "The ID of the operation returned.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the operation result.", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The status of the operation being performed.", + "enum": [ + "Canceled", + "Succeeded", + "Failed", + "Requested", + "Running" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "OperationResultStatus", + "modelAsString": true + } + }, + "startTime": { + "description": "The time that the operation was started.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": false, + "description": "Additional properties of the operation result." + } } - } } - }, - "Operation": { - "description": "Service REST API operation.", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" - }, - "origin": { - "readOnly": true, - "type": "string", - "description": "Default value is 'user,system'." - }, - "display": { - "description": "The information displayed about the operation.", - "$ref": "#/definitions/OperationDisplay" - } - } - }, - "OperationDisplay": { - "description": "The object that represents the operation.", - "type": "object", - "properties": { - "provider": { - "readOnly": true, + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, "type": "string", - "description": "Service provider: Microsoft.HealthcareApis" - }, - "resource": { - "readOnly": true, + "format": "uuid" + }, + "api-version": { + "name": "api-version", + "enum": [ + "2018-08-20-preview" + ], + "in": "query", + "description": "The version of the API.", + "required": true, "type": "string", - "description": "Resource Type: Services" - }, - "operation": { - "readOnly": true, + "minLength": 10 + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the service instance.", + "required": true, "type": "string", - "description": "Name of the operation" - }, - "description": { - "readOnly": true, + "x-ms-parameter-location": "method", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the service instance.", + "required": true, "type": "string", - "description": "Friendly description for the operation," - } - } - }, - "CheckNameAvailabilityParameters": { - "description": "Input values.", - "type": "object", - "properties": { - "name": { - "description": "The name of the service instance to check.", - "type": "string" - }, - "type": { - "description": "The fully qualified resource type which includes provider namespace.", - "type": "string" - } + "x-ms-parameter-location": "method", + "minLength": 3, + "maxLength": 24 }, - "required": [ - "name", - "type" - ] - }, - "ServicesNameAvailabilityInfo": { - "description": "The properties indicating whether a given service name is available.", - "type": "object", - "properties": { - "nameAvailable": { - "description": "The value which indicates whether the provided name is available.", - "type": "boolean", - "readOnly": true - }, - "reason": { - "description": "The reason for unavailability.", - "enum": [ - "Invalid", - "AlreadyExists" - ], + "locationName": { + "name": "locationName", + "in": "path", + "description": "The location of the operation.", + "required": true, "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ServiceNameUnavailabilityReason", - "modelAsString": false - } - }, - "message": { - "description": "The detailed reason message.", - "type": "string" - } - } - }, - "OperationResultsDescription": { - "description": "The properties indicating the operation result of an operation on a service.", - "type": "object", - "properties": { - "id": { - "description": "The ID of the operation returned.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the operation result.", - "readOnly": true, - "type": "string" - }, - "status": { - "description": "The status of the operation being performed.", - "enum": [ - "Canceled", - "Succeeded", - "Failed", - "Requested", - "Running" - ], - "readOnly": true, + "x-ms-parameter-location": "method" + }, + "operationResultId": { + "name": "operationResultId", + "in": "path", + "description": "The ID of the operation result to get.", + "required": true, "type": "string", - "x-ms-enum": { - "name": "OperationResultStatus", - "modelAsString": true - } - }, - "startTime": { - "description": "The time that the operation was started.", - "readOnly": true, - "type": "string" - }, - "properties": { - "x-ms-client-flatten": false, - "description": "Additional properties of the operation result." - } + "x-ms-parameter-location": "method" } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription identifier.", - "required": true, - "type": "string", - "format": "uuid" - }, - "api-version": { - "name": "api-version", - "enum": [ - "2018-08-20-preview" - ], - "in": "query", - "description": "The version of the API.", - "required": true, - "type": "string", - "minLength": 10 - }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the service instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90 - }, - "resourceName": { - "name": "resourceName", - "in": "path", - "description": "The name of the service instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "minLength": 3, - "maxLength": 24 - }, - "locationName": { - "name": "locationName", - "in": "path", - "description": "The location of the operation.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "operationResultId": { - "name": "operationResultId", - "in": "path", - "description": "The ID of the operation result to get.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } } -} \ No newline at end of file +} diff --git a/specification/healthcareapis/resource-manager/readme.go.md b/specification/healthcareapis/resource-manager/readme.go.md new file mode 100644 index 000000000000..9f499c737b1f --- /dev/null +++ b/specification/healthcareapis/resource-manager/readme.go.md @@ -0,0 +1,25 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: healthcareapis + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-08 +``` + +### Tag: package-2018-08 + +These settings apply only when `--tag=package-2018-08 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-08' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-08-20-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md new file mode 100644 index 000000000000..e833f58da65d --- /dev/null +++ b/specification/healthcareapis/resource-manager/readme.md @@ -0,0 +1,128 @@ +# HealthcareApis + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for HealthcareApis. + + + +--- +## Getting Started +To build the SDK for HealthcareApis, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the HANA on Azure API. + +``` yaml +title: HealthcareApisManagementClient +description: Azure Healthcare APIs Client +openapi-type: arm +tag: package-2018-08 +azure-arm: true +``` + + +### Tag: package-2018-08-preview + +These settings apply only when `--tag=package-2018-08` is specified on the command line. + +``` yaml $(tag) == 'package-2018-08' +input-file: +- Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json +``` + +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.healthcareapis + package-name: azure-mgmt-healthcareapis + clear-output-folder: true + package-version: 0.1.0 +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-healthcareapis/azure/mgmt/healthcareapis +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-healthcareapis +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.healthcareapis +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-healthcareapis +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-08 +``` + +### Tag: package-2018-08 and java + +These settings apply only when `--tag=package-2018-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.healthcareapis.v2018_08_20_preview + output-folder: $(azure-libraries-for-java-folder)/healthcareapis/resource-manager/v2017_11_03_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/healthcareapis/resource-manager/readme.nodejs.md b/specification/healthcareapis/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..a7e6d8b8d3ee --- /dev/null +++ b/specification/healthcareapis/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-healthcareapis + output-folder: $(node-sdks-folder)/lib/services/healthcareapisManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/healthcareapis/resource-manager/readme.typescript.md b/specification/healthcareapis/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..55bd3c06bde8 --- /dev/null +++ b/specification/healthcareapis/resource-manager/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-healthcareapis" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-healthcareapis" + generate-metadata: true +``` From 11a7929edd7816630bf501c8b7e6b4a53515968e Mon Sep 17 00:00:00 2001 From: Yazan Al-Alul Date: Wed, 6 Mar 2019 17:28:11 -0800 Subject: [PATCH 5/6] Fix version --- specification/healthcareapis/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/healthcareapis/resource-manager/readme.md b/specification/healthcareapis/resource-manager/readme.md index e833f58da65d..5827f8943630 100644 --- a/specification/healthcareapis/resource-manager/readme.md +++ b/specification/healthcareapis/resource-manager/readme.md @@ -120,7 +120,7 @@ Please also specify `--azure-libraries-for-java= Date: Tue, 12 Mar 2019 15:51:23 -0700 Subject: [PATCH 6/6] Fix operationID --- .../preview/2018-08-20-preview/healthcare-apis.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json index 57eb15eefb33..2a7c058417b6 100644 --- a/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json +++ b/specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/preview/2018-08-20-preview/healthcare-apis.json @@ -40,7 +40,7 @@ "Resource" ], "description": "Get the metadata of a service instance.", - "operationId": "Service_Get", + "operationId": "Services_Get", "x-ms-examples": { "ServiceGet": { "$ref": "./examples/ServiceGet.json" @@ -81,7 +81,7 @@ "Resource" ], "description": "Create or update the metadata of a service instance.", - "operationId": "Service_CreateOrUpdate", + "operationId": "Services_CreateOrUpdate", "x-ms-examples": { "ServicePut": { "$ref": "./examples/ServiceCreate.json" @@ -138,7 +138,7 @@ "Resource" ], "description": "Update the metadata of a service instance.", - "operationId": "Service_Update", + "operationId": "Services_Update", "x-ms-examples": { "ServicePatch": { "$ref": "./examples/ServicePatch.json" @@ -189,7 +189,7 @@ "Resource" ], "description": "Delete a service instance.", - "operationId": "Service_Delete", + "operationId": "Services_Delete", "x-ms-examples": { "ServiceDelete": { "$ref": "./examples/ServiceDelete.json" @@ -352,7 +352,7 @@ "Proxy" ], "description": "Check if a service instance name is available.", - "operationId": "Service_CheckNameAvailability", + "operationId": "Services_CheckNameAvailability", "x-ms-examples": { "ServiceList": { "$ref": "./examples/CheckNameAvailabilityPost.json" @@ -398,7 +398,7 @@ "Proxy" ], "description": "Moves resources to another subscription and/or resource group.", - "operationId": "Service_MoveResources", + "operationId": "Services_MoveResources", "x-ms-examples": { "ServiceList": { "$ref": "./examples/MoveResourcesPost.json"