From 3a3b09d2ef1e7a689ad37ef33820db650130c107 Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Thu, 19 Apr 2018 10:29:53 +0800 Subject: [PATCH 1/2] Update OperationId/Definition names for better SDK --- .../examples/CreateOrUpdate.json | 7 +- .../2018-03-01-preview/examples/Get.json | 3 +- .../examples/ListByResourceGroup.json | 3 +- .../examples/ListBySubscription.json | 3 +- .../2018-03-01-preview/examples/Update.json | 7 +- .../preview/2018-03-01-preview/signalr.json | 1666 ++++++++--------- 6 files changed, 849 insertions(+), 840 deletions(-) diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json index 4d7ae72aa398..958a0918e0d5 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json @@ -10,7 +10,9 @@ "tier": "Basic", "capacity": 1 }, - "properties": {} + "properties": { + "hostNamePrefix": null + } }, "api-version": "2018-03-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -31,7 +33,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json index 099be827dbdb..e5c12304fdde 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json @@ -19,7 +19,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json index 6cc07738f2db..4cfc7fa8ce31 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json @@ -20,7 +20,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json index 344a811a8a6c..e30deedf1515 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json @@ -19,7 +19,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json index 830275237aba..e3f2b57999b5 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json @@ -9,7 +9,9 @@ "tier": "Basic", "capacity": 1 }, - "properties": {} + "properties": { + "hostNamePrefix": null + } }, "api-version": "2018-03-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -30,7 +32,8 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002 + "serverPort": 5002, + "hostNamePrefix": null }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json index 2f5857bb24e9..ac06d217bc33 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json @@ -1,891 +1,891 @@ { "swagger": "2.0", "info": { - "version": "2018-03-01-preview", - "title": "SignalRManagementClient", - "description": "REST API for Azure SignalR Service" + "version": "2018-03-01-preview", + "title": "SignalrManagementClient", + "description": "REST API for Azure SignalR Service" }, "host": "management.azure.com", "schemes": [ - "https" + "https" ], "consumes": [ - "application/json" + "application/json" ], "produces": [ - "application/json" + "application/json" ], "paths": { - "/providers/Microsoft.SignalRService/operations": { - "get": { - "tags": [ - "SignalR" - ], - "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", - "operationId": "Signalr_ListOperations", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "Signalr" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of operations.", - "schema": { - "$ref": "#/definitions/OperationList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListOperations": { - "$ref": "./examples/ListOperations.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/checkNameAvailability": { - "post": { - "tags": [ - "SignalR" - ], - "description": "Checks that the SignalR name is valid and is not already in use.", - "operationId": "Signalr_CheckNameAvailability", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameters supplied to the operation.", - "required": false, - "schema": { - "$ref": "#/definitions/NameAvailabilityParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the name availability.", - "schema": { - "$ref": "#/definitions/NameAvailability" - } - } - }, - "x-ms-examples": { - "CheckNameAvailability": { - "$ref": "./examples/CheckNameAvailability.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/SignalR": { - "get": { - "tags": [ - "SignalR" - ], - "description": "Handles requests to list all resources in a subscription.", - "operationId": "Signalr_ListBySubscription", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of SignalR services in the subscription.", - "schema": { - "$ref": "#/definitions/SignalRResourceList" - } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/checkNameAvailability": { + "post": { + "tags": [ + "Signalr" + ], + "description": "Checks that the SignalR name is valid and is not already in use.", + "operationId": "Signalr_CheckNameAvailability", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": false, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListBySubscription": { - "$ref": "./examples/ListBySubscription.json" + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/SignalR": { + "get": { + "tags": [ + "Signalr" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "Signalr_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in the subscription.", + "schema": { + "$ref": "#/definitions/SignalrResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListBySubscription": { + "$ref": "./examples/ListBySubscription.json" + } + } } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR": { - "get": { - "tags": [ - "SignalR" - ], - "description": "Handles requests to list all resources in a resource group.", - "operationId": "Signalr_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR": { + "get": { + "tags": [ + "Signalr" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "Signalr_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in a resourceGroup.", + "schema": { + "$ref": "#/definitions/SignalrResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListByResourceGroup": { + "$ref": "./examples/ListByResourceGroup.json" + } + } } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of SignalR services in a resourceGroup.", - "schema": { - "$ref": "#/definitions/SignalRResourceList" - } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/listKeys": { + "post": { + "tags": [ + "Signalr" + ], + "description": "Get the access keys of the SignalR resource.", + "operationId": "Signalr_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes SignalR service access keys.", + "schema": { + "$ref": "#/definitions/SignalrKeys" + } + } + }, + "x-ms-examples": { + "ListKeys": { + "$ref": "./examples/ListKeys.json" + } + } } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListByResourceGroup": { - "$ref": "./examples/ListByResourceGroup.json" + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "Signalr" + ], + "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "Signalr_RegenerateKey", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": false, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" + } + ], + "responses": { + "201": { + "description": "Created and an async operation is excuting in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/SignalrKeys" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RegenerateKey": { + "$ref": "./examples/RegenerateKey.json" + } + } } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/listKeys": { - "post": { - "tags": [ - "SignalR" - ], - "description": "Get the access keys of the SignalR resource.", - "operationId": "Signalr_ListKeys", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}": { + "get": { + "tags": [ + "Signalr" + ], + "description": "Get the SignalR service and its properties.", + "operationId": "Signalr_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding SingalR service.", + "schema": { + "$ref": "#/definitions/SignalrResource" + } + } + }, + "x-ms-examples": { + "Get": { + "$ref": "./examples/Get.json" + } + } }, - { - "$ref": "#/parameters/SubscriptionIdParameter" + "put": { + "tags": [ + "Signalr" + ], + "description": "Create a new SignalR service and update an exiting SignalR service.", + "operationId": "Signalr_CreateOrUpdate", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalrCreateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" + } + ], + "responses": { + "201": { + "description": "Created. The response describes the new service and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/SignalrResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateOrUpdate": { + "$ref": "./examples/CreateOrUpdate.json" + } + } }, - { - "$ref": "#/parameters/ResourceGroupParameter" + "delete": { + "tags": [ + "Signalr" + ], + "description": "Operation to delete a SignalR service.", + "operationId": "Signalr_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete": { + "$ref": "./examples/Delete.json" + } + } }, - { - "$ref": "#/parameters/SignalRServiceName" + "patch": { + "tags": [ + "Signalr" + ], + "description": "Operation to update an exiting SignalR service.", + "operationId": "Signalr_Update", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalrUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a SingalR service which is not up-to-date.", + "schema": { + "$ref": "#/definitions/SignalrResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update": { + "$ref": "./examples/Update.json" + } + } } - ], - "responses": { - "200": { - "description": "Success. The response describes SignalR service access keys.", - "schema": { - "$ref": "#/definitions/SignalRKeys" - } - } - }, - "x-ms-examples": { - "ListKeys": { - "$ref": "./examples/ListKeys.json" - } - } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/regenerateKey": { - "post": { - "tags": [ - "SignalR" - ], - "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", - "operationId": "Signalr_RegenerateKey", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameter that describes the Regenerate Key Operation.", - "required": false, - "schema": { - "$ref": "#/definitions/RegenerateKeyParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalRServiceName" - } - ], - "responses": { - "201": { - "description": "Created and an async operation is excuting in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", - "schema": { - "$ref": "#/definitions/SignalRKeys" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "RegenerateKey": { - "$ref": "./examples/RegenerateKey.json" + }, + "definitions": { + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}": { - "get": { - "tags": [ - "SignalR" - ], - "description": "Get the SignalR service and its properties.", - "operationId": "Signalr_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalRServiceName" + }, + "Operation": { + "description": "REST API operation supported by SignalR resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false + } } - ], - "responses": { - "200": { - "description": "Success. The response describe the corresponding SingalR service.", - "schema": { - "$ref": "#/definitions/SignalRResource" - } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } } - }, - "x-ms-examples": { - "Get": { - "$ref": "./examples/Get.json" + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } } - } }, - "put": { - "tags": [ - "SignalR" - ], - "description": "Create a new SignalR service and update an exiting SignalR service.", - "operationId": "Signalr_CreateOrUpdate", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameters for the create or update operation", - "required": false, - "schema": { - "$ref": "#/definitions/SignalRCreateParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalRServiceName" + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } } - ], - "responses": { - "201": { - "description": "Created. The response describes the new service and contains a Location header to query the operation result.", - "schema": { - "$ref": "#/definitions/SignalRResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + } } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "CreateOrUpdate": { - "$ref": "./examples/CreateOrUpdate.json" + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "type", + "name" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", + "type": "string" + }, + "name": { + "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", + "type": "string" + } } - } }, - "delete": { - "tags": [ - "SignalR" - ], - "description": "Operation to delete a SignalR service.", - "operationId": "Signalr_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalRServiceName" + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } } - ], - "responses": { - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." - }, - "204": { - "description": "Success. The response indicates the resource is already deleted." + }, + "SignalrResourceList": { + "description": "Object that includes an array of SignalR services and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of SignalR services", + "type": "array", + "items": { + "$ref": "#/definitions/SignalrResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete": { - "$ref": "./examples/Delete.json" + }, + "SignalrResource": { + "description": "A class represent a SignalR service resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "SKU of the service." + }, + "properties": { + "$ref": "#/definitions/SignalrProperties", + "description": "The properties of the service.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resouce.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } } - } }, - "patch": { - "tags": [ - "SignalR" - ], - "description": "Operation to update an exiting SignalR service.", - "operationId": "Signalr_Update", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameters for the update operation", - "required": false, - "schema": { - "$ref": "#/definitions/SignalRUpdateParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalRServiceName" + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } } - ], - "responses": { - "200": { - "description": "Success. The response describes a SingalR service which is not up-to-date.", - "schema": { - "$ref": "#/definitions/SignalRResource" - } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resouce.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } }, - "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update": { - "$ref": "./examples/Update.json" - } - } - } - } - }, - "definitions": { - "OperationList": { - "description": "Result of the request to list REST API operations. It contains a list of operations.", - "type": "object", - "properties": { - "value": { - "description": "List of operations supported by the resource provider.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" + "x-ms-azure-resource": true + }, + "ResourceSku": { + "description": "The billing information of the resource.(e.g. basic vs. standard)", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified)", + "type": "string" + }, + "tier": { + "description": "The tier of this particular SKU. Optional.", + "enum": [ + "Free", + "Basic", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalrSkuTier", + "modelAsString": true + } + }, + "size": { + "description": "Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "family": { + "description": "Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not \r\npossible for the resource this may be omitted.", + "type": "integer" + } } - }, - "nextLink": { - "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } - } - }, - "Operation": { - "description": "REST API operation supported by SignalR resource provider.", - "type": "object", - "properties": { - "name": { - "description": "Name of the operation with format: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "The object that describes the operation." - }, - "origin": { - "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Extra properties for the operation.", - "x-ms-client-flatten": false - } - } - }, - "OperationDisplay": { - "description": "The object that describes a operation.", - "type": "object", - "properties": { - "provider": { - "description": "Friendly name of the resource provider", - "type": "string" - }, - "resource": { - "description": "Resource type on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "The localized friendly name for the operation.", - "type": "string" - }, - "description": { - "description": "The localized friendly description for the operation", - "type": "string" - } - } - }, - "OperationProperties": { - "description": "Extra Operation properties.", - "type": "object", - "properties": { - "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "The service specifications." - } - } - }, - "ServiceSpecification": { - "description": "An object that describes a specification.", - "type": "object", - "properties": { - "metricSpecifications": { - "description": "Specifications of the Metrics for Azure Monitoring.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" + }, + "SignalrProperties": { + "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalrCreateOrUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "externalIP": { + "description": "The publicly accessible IP of the SignalR service.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessibly port of the SignalR service which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessibly port of the SignalR service which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + } } - } - } - }, - "MetricSpecification": { - "description": "Specifications of the Metrics for Azure Monitoring.", - "type": "object", - "properties": { - "name": { - "description": "Name of the metric.", - "type": "string" - }, - "displayName": { - "description": "Localized friendly display name of the metric.", - "type": "string" - }, - "displayDescription": { - "description": "Localized friendly description of the metric.", - "type": "string" - }, - "unit": { - "description": "The unit that makes sense for the metric.", - "type": "string" - }, - "aggregationType": { - "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", - "type": "string" - }, - "fillGapWithZero": { - "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", - "type": "string" - }, - "category": { - "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", - "type": "string" - } - } - }, - "NameAvailabilityParameters": { - "description": "Data POST-ed to the nameAvailability action", - "required": [ - "type", - "name" - ], - "type": "object", - "properties": { - "type": { - "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", - "type": "string" - }, - "name": { - "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", - "type": "string" - } - } - }, - "NameAvailability": { - "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", - "type": "object", - "properties": { - "nameAvailable": { - "description": "Indicates whether the name is available or not.", - "type": "boolean" - }, - "reason": { - "description": "The reason of the availability. Required if name is not available.", - "type": "string" - }, - "message": { - "description": "The message of the operation.", - "type": "string" - } - } - }, - "SignalRResourceList": { - "description": "Object that includes an array of SignalR services and a possible link for next set.", - "type": "object", - "properties": { - "value": { - "description": "List of SignalR services", - "type": "array", - "items": { - "$ref": "#/definitions/SignalRResource" + }, + "SignalrCreateOrUpdateProperties": { + "description": "Settings used to provision or configure the resource.", + "type": "object", + "properties": { + "hostNamePrefix": { + "description": "Prefix for the hostName of the SignalR service. Retained for future use.\r\nThe hostname will be of format: <hostNamePrefix>.service.signalr.net.", + "type": "string" + } } - }, - "nextLink": { - "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } - } - }, - "SignalRResource": { - "description": "A class represent a SignalR service resource.", - "type": "object", - "x-ms-client-name": "SignalrResourceList", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "sku": { - "$ref": "#/definitions/ResourceSku", - "x-ms-client-name": "signalrsku", - "description": "SKU of the service." - }, - "properties": { - "$ref": "#/definitions/SignalRProperties", - "description": "The properties of the service.", - "x-ms-client-flatten": true - }, - "id": { - "description": "Fully qualified resource Id for the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resouce.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", - "type": "string", - "readOnly": true - } - } - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Tags of the service which is a list of key value pairs that describe the resource.", + }, + "SignalrKeys": { + "description": "A class represents the access keys of SignalR service.", "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ] - } - } - }, - "Resource": { - "description": "The core properties of ARM resources.", - "type": "object", - "properties": { - "id": { - "description": "Fully qualified resource Id for the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resouce.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", - "type": "string", - "readOnly": true - } + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string" + } + } }, - "x-ms-azure-resource": true - }, - "ResourceSku": { - "description": "The billing information of the resource.(e.g. basic vs. standard)", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified)", - "type": "string" - }, - "tier": { - "description": "The tier of this particular SKU. Optional.", - "enum": [ - "Free", - "Basic", - "Premium" - ], - "type": "string", - "x-ms-enum": { - "name": "SignalRSkuTier", - "modelAsString": true + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + } } - }, - "size": { - "description": "Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code.", - "type": "string" - }, - "family": { - "description": "Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, - "capacity": { - "format": "int32", - "description": "Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not \r\npossible for the resource this may be omitted.", - "type": "integer" - } - } - }, - "SignalRProperties": { - "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SignalRCreateOrUpdateProperties" - } - ], - "properties": { - "provisioningState": { - "description": "Provisioning state of the resource.", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Creating", - "Updating", - "Deleting", - "Moving" + }, + "SignalrCreateParameters": { + "description": "Parameters for SignalR service create/update operation.\r\n\r\nKeep the same schema as AzSignalR.Models.SignalRResource", + "required": [ + "location" ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "externalIP": { - "description": "The publicly accessible IP of the SignalR service.", - "type": "string", - "readOnly": true - }, - "hostName": { - "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net", - "type": "string", - "readOnly": true - }, - "publicPort": { - "format": "int32", - "description": "The publicly accessibly port of the SignalR service which is designed for browser/client side usage.", - "type": "integer", - "readOnly": true - }, - "serverPort": { - "format": "int32", - "description": "The publicly accessibly port of the SignalR service which is designed for customer server side usage.", - "type": "integer", - "readOnly": true - } - } - }, - "SignalRCreateOrUpdateProperties": { - "description": "Settings used to provision or configure the resource.", - "type": "object", - "properties": { - "hostNamePrefix": { - "description": "Prefix for the hostName of the SignalR service. Retained for future use.\r\nThe hostname will be of format: <hostNamePrefix>.service.signalr.net.", - "type": "string" - } - } - }, - "SignalRKeys": { - "description": "A class represents the access keys of SignalR service.", - "type": "object", - "properties": { - "primaryKey": { - "description": "The primary access key.", - "type": "string" - }, - "secondaryKey": { - "description": "The secondary access key.", - "type": "string" - } - } - }, - "RegenerateKeyParameters": { - "description": "Parameters describes the request to regenerate access keys", - "type": "object", - "properties": { - "keyType": { - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", - "enum": [ - "Primary", - "Secondary" + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalrUpdateParameters" + } ], - "type": "string", - "x-ms-enum": { - "name": "KeyType", - "modelAsString": true + "properties": { + "location": { + "description": "Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc. \r\nThe geo region of a resource never changes after it is created.", + "type": "string" + } } - } - } - }, - "SignalRCreateParameters": { - "description": "Parameters for SignalR service create/update operation.\r\n\r\nKeep the same schema as AzSignalR.Models.SignalRResource", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SignalRUpdateParameters" - } - ], - "properties": { - "location": { - "description": "Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc. \r\nThe geo region of a resource never changes after it is created.", - "type": "string" - } - } - }, - "SignalRUpdateParameters": { - "description": "Parameters for SignalR service update operation", - "type": "object", - "properties": { - "tags": { - "description": "A list of key value pairs that describe the resource.", + }, + "SignalrUpdateParameters": { + "description": "Parameters for SignalR service update operation", "type": "object", - "additionalProperties": { - "type": "string" + "properties": { + "tags": { + "description": "A list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. basic vs. standard)" + }, + "properties": { + "$ref": "#/definitions/SignalrCreateOrUpdateProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": false + } } - }, - "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "The billing information of the resource.(e.g. basic vs. standard)" - }, - "properties": { - "$ref": "#/definitions/SignalRCreateOrUpdateProperties", - "description": "Settings used to provision or configure the resource", - "x-ms-client-flatten": false - } } - } }, "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client Api Version.", - "required": true, - "type": "string" - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SignalRServiceName": { - "name": "resourceName", - "in": "path", - "description": "The name of the SignalR resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SignalrServiceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the SignalR resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } }, "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow" - } + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } }, "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } + { + "azure_auth": [ + "user_impersonation" + ] + } ] } \ No newline at end of file From 03bd1bc1a6a0a3bd915e26085cfb057be94ee7c0 Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Thu, 19 Apr 2018 10:37:55 +0800 Subject: [PATCH 2/2] fix indentation --- .../examples/CreateOrUpdate.json | 7 +- .../2018-03-01-preview/examples/Get.json | 3 +- .../examples/ListByResourceGroup.json | 3 +- .../examples/ListBySubscription.json | 3 +- .../2018-03-01-preview/examples/Update.json | 7 +- .../preview/2018-03-01-preview/signalr.json | 1661 ++++++++--------- 6 files changed, 835 insertions(+), 849 deletions(-) diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json index 958a0918e0d5..4d7ae72aa398 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/CreateOrUpdate.json @@ -10,9 +10,7 @@ "tier": "Basic", "capacity": 1 }, - "properties": { - "hostNamePrefix": null - } + "properties": {} }, "api-version": "2018-03-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -33,8 +31,7 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002, - "hostNamePrefix": null + "serverPort": 5002 }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json index e5c12304fdde..099be827dbdb 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Get.json @@ -19,8 +19,7 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002, - "hostNamePrefix": null + "serverPort": 5002 }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json index 4cfc7fa8ce31..6cc07738f2db 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListByResourceGroup.json @@ -20,8 +20,7 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002, - "hostNamePrefix": null + "serverPort": 5002 }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json index e30deedf1515..344a811a8a6c 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/ListBySubscription.json @@ -19,8 +19,7 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002, - "hostNamePrefix": null + "serverPort": 5002 }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json index e3f2b57999b5..830275237aba 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/examples/Update.json @@ -9,9 +9,7 @@ "tier": "Basic", "capacity": 1 }, - "properties": { - "hostNamePrefix": null - } + "properties": {} }, "api-version": "2018-03-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -32,8 +30,7 @@ "externalIP": "10.0.0.1", "hostName": "myservice.service.signalr.net", "publicPort": 5001, - "serverPort": 5002, - "hostNamePrefix": null + "serverPort": 5002 }, "location": "eastus", "tags": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json index ac06d217bc33..152d1c5ffa53 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json @@ -1,891 +1,886 @@ { "swagger": "2.0", "info": { - "version": "2018-03-01-preview", - "title": "SignalrManagementClient", - "description": "REST API for Azure SignalR Service" + "version": "2018-03-01-preview", + "title": "SignalrManagementClient", + "description": "REST API for Azure SignalR Service" }, "host": "management.azure.com", "schemes": [ - "https" + "https" ], "consumes": [ - "application/json" + "application/json" ], "produces": [ - "application/json" + "application/json" ], "paths": { - "/providers/Microsoft.SignalRService/operations": { - "get": { - "tags": [ - "Signalr" - ], - "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of operations.", - "schema": { - "$ref": "#/definitions/OperationList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListOperations": { - "$ref": "./examples/ListOperations.json" - } - } + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "Signalr" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/checkNameAvailability": { - "post": { - "tags": [ - "Signalr" - ], - "description": "Checks that the SignalR name is valid and is not already in use.", - "operationId": "Signalr_CheckNameAvailability", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameters supplied to the operation.", - "required": false, - "schema": { - "$ref": "#/definitions/NameAvailabilityParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the name availability.", - "schema": { - "$ref": "#/definitions/NameAvailability" - } - } - }, - "x-ms-examples": { - "CheckNameAvailability": { - "$ref": "./examples/CheckNameAvailability.json" - } - } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/SignalR": { - "get": { - "tags": [ - "Signalr" - ], - "description": "Handles requests to list all resources in a subscription.", - "operationId": "Signalr_ListBySubscription", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of SignalR services in the subscription.", - "schema": { - "$ref": "#/definitions/SignalrResourceList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListBySubscription": { - "$ref": "./examples/ListBySubscription.json" - } - } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR": { - "get": { - "tags": [ - "Signalr" - ], - "description": "Handles requests to list all resources in a resource group.", - "operationId": "Signalr_ListByResourceGroup", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of SignalR services in a resourceGroup.", - "schema": { - "$ref": "#/definitions/SignalrResourceList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "ListByResourceGroup": { - "$ref": "./examples/ListByResourceGroup.json" - } - } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/checkNameAvailability": { + "post": { + "tags": [ + "Signalr" + ], + "description": "Checks that the SignalR name is valid and is not already in use.", + "operationId": "Signalr_CheckNameAvailability", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": false, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/listKeys": { - "post": { - "tags": [ - "Signalr" - ], - "description": "Get the access keys of the SignalR resource.", - "operationId": "Signalr_ListKeys", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalrServiceName" - } - ], - "responses": { - "200": { - "description": "Success. The response describes SignalR service access keys.", - "schema": { - "$ref": "#/definitions/SignalrKeys" - } - } - }, - "x-ms-examples": { - "ListKeys": { - "$ref": "./examples/ListKeys.json" - } - } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/regenerateKey": { - "post": { - "tags": [ - "Signalr" - ], - "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", - "operationId": "Signalr_RegenerateKey", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameter that describes the Regenerate Key Operation.", - "required": false, - "schema": { - "$ref": "#/definitions/RegenerateKeyParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalrServiceName" - } - ], - "responses": { - "201": { - "description": "Created and an async operation is excuting in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", - "schema": { - "$ref": "#/definitions/SignalrKeys" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "RegenerateKey": { - "$ref": "./examples/RegenerateKey.json" - } - } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}": { - "get": { - "tags": [ - "Signalr" - ], - "description": "Get the SignalR service and its properties.", - "operationId": "Signalr_Get", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalrServiceName" - } - ], - "responses": { - "200": { - "description": "Success. The response describe the corresponding SingalR service.", - "schema": { - "$ref": "#/definitions/SignalrResource" - } - } - }, - "x-ms-examples": { - "Get": { - "$ref": "./examples/Get.json" - } - } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/SignalR": { + "get": { + "tags": [ + "Signalr" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "Signalr_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" }, - "put": { - "tags": [ - "Signalr" - ], - "description": "Create a new SignalR service and update an exiting SignalR service.", - "operationId": "Signalr_CreateOrUpdate", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameters for the create or update operation", - "required": false, - "schema": { - "$ref": "#/definitions/SignalrCreateParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalrServiceName" - } - ], - "responses": { - "201": { - "description": "Created. The response describes the new service and contains a Location header to query the operation result.", - "schema": { - "$ref": "#/definitions/SignalrResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "CreateOrUpdate": { - "$ref": "./examples/CreateOrUpdate.json" - } - } + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in the subscription.", + "schema": { + "$ref": "#/definitions/SignalrResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListBySubscription": { + "$ref": "./examples/ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR": { + "get": { + "tags": [ + "Signalr" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "Signalr_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" }, - "delete": { - "tags": [ - "Signalr" - ], - "description": "Operation to delete a SignalR service.", - "operationId": "Signalr_Delete", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalrServiceName" - } - ], - "responses": { - "202": { - "description": "Accepted. The response indicates the delete operation is performed in the background." - }, - "204": { - "description": "Success. The response indicates the resource is already deleted." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete": { - "$ref": "./examples/Delete.json" - } - } + { + "$ref": "#/parameters/SubscriptionIdParameter" }, - "patch": { - "tags": [ - "Signalr" - ], - "description": "Operation to update an exiting SignalR service.", - "operationId": "Signalr_Update", - "parameters": [ - { - "name": "parameters", - "in": "body", - "description": "Parameters for the update operation", - "required": false, - "schema": { - "$ref": "#/definitions/SignalrUpdateParameters" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/SignalrServiceName" - } - ], - "responses": { - "200": { - "description": "Success. The response describes a SingalR service which is not up-to-date.", - "schema": { - "$ref": "#/definitions/SignalrResource" - } - }, - "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update": { - "$ref": "./examples/Update.json" - } - } + { + "$ref": "#/parameters/ResourceGroupParameter" } - } - }, - "definitions": { - "OperationList": { - "description": "Result of the request to list REST API operations. It contains a list of operations.", - "type": "object", - "properties": { - "value": { - "description": "List of operations supported by the resource provider.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in a resourceGroup.", + "schema": { + "$ref": "#/definitions/SignalrResourceList" + } } - }, - "Operation": { - "description": "REST API operation supported by SignalR resource provider.", - "type": "object", - "properties": { - "name": { - "description": "Name of the operation with format: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "The object that describes the operation." - }, - "origin": { - "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Extra properties for the operation.", - "x-ms-client-flatten": false - } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListByResourceGroup": { + "$ref": "./examples/ListByResourceGroup.json" } - }, - "OperationDisplay": { - "description": "The object that describes a operation.", - "type": "object", - "properties": { - "provider": { - "description": "Friendly name of the resource provider", - "type": "string" - }, - "resource": { - "description": "Resource type on which the operation is performed.", - "type": "string" - }, - "operation": { - "description": "The localized friendly name for the operation.", - "type": "string" - }, - "description": { - "description": "The localized friendly description for the operation", - "type": "string" - } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/listKeys": { + "post": { + "tags": [ + "Signalr" + ], + "description": "Get the access keys of the SignalR resource.", + "operationId": "Signalr_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" } - }, - "OperationProperties": { - "description": "Extra Operation properties.", - "type": "object", - "properties": { - "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "The service specifications." - } + ], + "responses": { + "200": { + "description": "Success. The response describes SignalR service access keys.", + "schema": { + "$ref": "#/definitions/SignalrKeys" + } } - }, - "ServiceSpecification": { - "description": "An object that describes a specification.", - "type": "object", - "properties": { - "metricSpecifications": { - "description": "Specifications of the Metrics for Azure Monitoring.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" - } - } + }, + "x-ms-examples": { + "ListKeys": { + "$ref": "./examples/ListKeys.json" } - }, - "MetricSpecification": { - "description": "Specifications of the Metrics for Azure Monitoring.", - "type": "object", - "properties": { - "name": { - "description": "Name of the metric.", - "type": "string" - }, - "displayName": { - "description": "Localized friendly display name of the metric.", - "type": "string" - }, - "displayDescription": { - "description": "Localized friendly description of the metric.", - "type": "string" - }, - "unit": { - "description": "The unit that makes sense for the metric.", - "type": "string" - }, - "aggregationType": { - "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", - "type": "string" - }, - "fillGapWithZero": { - "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", - "type": "string" - }, - "category": { - "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", - "type": "string" - } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "Signalr" + ], + "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "Signalr_RegenerateKey", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": false, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" } - }, - "NameAvailabilityParameters": { - "description": "Data POST-ed to the nameAvailability action", - "required": [ - "type", - "name" - ], - "type": "object", - "properties": { - "type": { - "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", - "type": "string" - }, - "name": { - "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", - "type": "string" - } + ], + "responses": { + "201": { + "description": "Created and an async operation is excuting in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/SignalrKeys" + } } - }, - "NameAvailability": { - "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", - "type": "object", - "properties": { - "nameAvailable": { - "description": "Indicates whether the name is available or not.", - "type": "boolean" - }, - "reason": { - "description": "The reason of the availability. Required if name is not available.", - "type": "string" - }, - "message": { - "description": "The message of the operation.", - "type": "string" - } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RegenerateKey": { + "$ref": "./examples/RegenerateKey.json" } - }, - "SignalrResourceList": { - "description": "Object that includes an array of SignalR services and a possible link for next set.", - "type": "object", - "properties": { - "value": { - "description": "List of SignalR services", - "type": "array", - "items": { - "$ref": "#/definitions/SignalrResource" - } - }, - "nextLink": { - "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", - "type": "string" - } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}": { + "get": { + "tags": [ + "Signalr" + ], + "description": "Get the SignalR service and its properties.", + "operationId": "Signalr_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" } - }, - "SignalrResource": { - "description": "A class represent a SignalR service resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "SKU of the service." - }, - "properties": { - "$ref": "#/definitions/SignalrProperties", - "description": "The properties of the service.", - "x-ms-client-flatten": true - }, - "id": { - "description": "Fully qualified resource Id for the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resouce.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", - "type": "string", - "readOnly": true - } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding SingalR service.", + "schema": { + "$ref": "#/definitions/SignalrResource" + } } - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Tags of the service which is a list of key value pairs that describe the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ] - } + }, + "x-ms-examples": { + "Get": { + "$ref": "./examples/Get.json" } + } }, - "Resource": { - "description": "The core properties of ARM resources.", - "type": "object", - "properties": { - "id": { - "description": "Fully qualified resource Id for the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resouce.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", - "type": "string", - "readOnly": true - } + "put": { + "tags": [ + "Signalr" + ], + "description": "Create a new SignalR service and update an exiting SignalR service.", + "operationId": "Signalr_CreateOrUpdate", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalrCreateParameters" + } }, - "x-ms-azure-resource": true - }, - "ResourceSku": { - "description": "The billing information of the resource.(e.g. basic vs. standard)", - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified)", - "type": "string" - }, - "tier": { - "description": "The tier of this particular SKU. Optional.", - "enum": [ - "Free", - "Basic", - "Premium" - ], - "type": "string", - "x-ms-enum": { - "name": "SignalrSkuTier", - "modelAsString": true - } - }, - "size": { - "description": "Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code.", - "type": "string" - }, - "family": { - "description": "Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here.", - "type": "string" - }, - "capacity": { - "format": "int32", - "description": "Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not \r\npossible for the resource this may be omitted.", - "type": "integer" - } + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" } - }, - "SignalrProperties": { - "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SignalrCreateOrUpdateProperties" - } - ], - "properties": { - "provisioningState": { - "description": "Provisioning state of the resource.", - "enum": [ - "Unknown", - "Succeeded", - "Failed", - "Canceled", - "Running", - "Creating", - "Updating", - "Deleting", - "Moving" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "externalIP": { - "description": "The publicly accessible IP of the SignalR service.", - "type": "string", - "readOnly": true - }, - "hostName": { - "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net", - "type": "string", - "readOnly": true - }, - "publicPort": { - "format": "int32", - "description": "The publicly accessibly port of the SignalR service which is designed for browser/client side usage.", - "type": "integer", - "readOnly": true - }, - "serverPort": { - "format": "int32", - "description": "The publicly accessibly port of the SignalR service which is designed for customer server side usage.", - "type": "integer", - "readOnly": true - } + ], + "responses": { + "201": { + "description": "Created. The response describes the new service and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/SignalrResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." } - }, - "SignalrCreateOrUpdateProperties": { - "description": "Settings used to provision or configure the resource.", - "type": "object", - "properties": { - "hostNamePrefix": { - "description": "Prefix for the hostName of the SignalR service. Retained for future use.\r\nThe hostname will be of format: <hostNamePrefix>.service.signalr.net.", - "type": "string" - } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateOrUpdate": { + "$ref": "./examples/CreateOrUpdate.json" } + } }, - "SignalrKeys": { - "description": "A class represents the access keys of SignalR service.", - "type": "object", - "properties": { - "primaryKey": { - "description": "The primary access key.", - "type": "string" - }, - "secondaryKey": { - "description": "The secondary access key.", - "type": "string" - } + "delete": { + "tags": [ + "Signalr" + ], + "description": "Operation to delete a SignalR service.", + "operationId": "Signalr_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" } - }, - "RegenerateKeyParameters": { - "description": "Parameters describes the request to regenerate access keys", - "type": "object", - "properties": { - "keyType": { - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", - "enum": [ - "Primary", - "Secondary" - ], - "type": "string", - "x-ms-enum": { - "name": "KeyType", - "modelAsString": true - } - } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." } - }, - "SignalrCreateParameters": { - "description": "Parameters for SignalR service create/update operation.\r\n\r\nKeep the same schema as AzSignalR.Models.SignalRResource", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SignalrUpdateParameters" - } - ], - "properties": { - "location": { - "description": "Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc. \r\nThe geo region of a resource never changes after it is created.", - "type": "string" - } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete": { + "$ref": "./examples/Delete.json" } + } }, - "SignalrUpdateParameters": { - "description": "Parameters for SignalR service update operation", - "type": "object", - "properties": { - "tags": { - "description": "A list of key value pairs that describe the resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "The billing information of the resource.(e.g. basic vs. standard)" - }, - "properties": { - "$ref": "#/definitions/SignalrCreateOrUpdateProperties", - "description": "Settings used to provision or configure the resource", - "x-ms-client-flatten": false - } + "patch": { + "tags": [ + "Signalr" + ], + "description": "Operation to update an exiting SignalR service.", + "operationId": "Signalr_Update", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalrUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalrServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a SingalR service which is not up-to-date.", + "schema": { + "$ref": "#/definitions/SignalrResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update": { + "$ref": "./examples/Update.json" } + } } + } }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client Api Version.", - "required": true, + "definitions": { + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", "type": "string" - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, + } + } + }, + "Operation": { + "description": "REST API operation supported by SignalR resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", "type": "string" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "type", + "name" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", + "type": "string" + }, + "name": { + "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", + "type": "string" + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "SignalrResourceList": { + "description": "Object that includes an array of SignalR services and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of SignalR services", + "type": "array", + "items": { + "$ref": "#/definitions/SignalrResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalrResource": { + "description": "A class represent a SignalR service resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "SKU of the service." + }, + "properties": { + "$ref": "#/definitions/SignalrProperties", + "description": "The properties of the service.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resouce.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", "type": "string", - "x-ms-parameter-location": "method" + "readOnly": true + } + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resouce.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } }, - "SignalrServiceName": { - "name": "resourceName", - "in": "path", - "description": "The name of the SignalR resource.", - "required": true, + "x-ms-azure-resource": true + }, + "ResourceSku": { + "description": "The billing information of the resource.(e.g. basic vs. standard)", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified)", + "type": "string" + }, + "tier": { + "description": "The tier of this particular SKU. Optional.", + "enum": [ + "Free", + "Basic", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalrSkuTier", + "modelAsString": true + } + }, + "size": { + "description": "Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "family": { + "description": "Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not \r\npossible for the resource this may be omitted.", + "type": "integer" + } + } + }, + "SignalrProperties": { + "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalrCreateOrUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "externalIP": { + "description": "The publicly accessible IP of the SignalR service.", "type": "string", - "x-ms-parameter-location": "method" + "readOnly": true + }, + "hostName": { + "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessibly port of the SignalR service which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessibly port of the SignalR service which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + } + } + }, + "SignalrCreateOrUpdateProperties": { + "description": "Settings used to provision or configure the resource.", + "type": "object", + "properties": {} + }, + "SignalrKeys": { + "description": "A class represents the access keys of SignalR service.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string" + } + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + } + } + }, + "SignalrCreateParameters": { + "description": "Parameters for SignalR service create/update operation.\r\n\r\nKeep the same schema as AzSignalR.Models.SignalRResource", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalrUpdateParameters" + } + ], + "properties": { + "location": { + "description": "Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc. \r\nThe geo region of a resource never changes after it is created.", + "type": "string" + } } + }, + "SignalrUpdateParameters": { + "description": "Parameters for SignalR service update operation", + "type": "object", + "properties": { + "tags": { + "description": "A list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. basic vs. standard)" + }, + "properties": { + "$ref": "#/definitions/SignalrCreateOrUpdateProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": false + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SignalrServiceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the SignalR resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } }, "securityDefinitions": { - "azure_auth": { - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow" - } + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } }, "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } + { + "azure_auth": [ + "user_impersonation" + ] + } ] } \ No newline at end of file