From 2a420ffc8c17899282ee618af65815e9685c18a9 Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Tue, 12 Jan 2021 10:49:40 +0800 Subject: [PATCH] reorder Paths and definitions --- .../preview/2020-07-01-preview/signalr.json | 1610 ++++++++--------- 1 file changed, 805 insertions(+), 805 deletions(-) diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json index 7280df736977..227befcbcdf6 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json @@ -104,6 +104,52 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List usage quotas for Azure SignalR service by location.", + "operationId": "Usages_List", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRUsageList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR": { "get": { "tags": [ @@ -185,21 +231,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}": { "get": { "tags": [ "SignalR" ], - "description": "Get the specified private endpoint connection associated with a SignalR resource.", - "operationId": "SignalRPrivateEndpointConnections_Get", + "description": "Get the SignalR service and its properties.", + "operationId": "SignalR_Get", "parameters": [ - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection associated with the SignalR resource.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -215,9 +254,9 @@ ], "responses": { "200": { - "description": "Success. The response describes a list of private link resources.", + "description": "Success. The response describes the corresponding SignalR service.", "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/SignalRResource" } }, "default": { @@ -228,8 +267,8 @@ } }, "x-ms-examples": { - "SignalRPrivateEndpointConnections_Get": { - "$ref": "./examples/SignalRPrivateEndpointConnections_Get.json" + "SignalR_Get": { + "$ref": "./examples/SignalR_Get.json" } } }, @@ -237,23 +276,16 @@ "tags": [ "SignalR" ], - "description": "Update the state of specified private endpoint connection associated with a SignalR resource.", - "operationId": "SignalRPrivateEndpointConnections_Update", + "description": "Create a new SignalR service and update an exiting SignalR service.", + "operationId": "SignalR_CreateOrUpdate", "parameters": [ - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection associated with the SignalR resource.", - "required": true, - "type": "string" - }, { "name": "parameters", "in": "body", - "description": "The resource of private endpoint and its properties.", + "description": "Parameters for the create or update operation", "required": false, "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/SignalRResource" } }, { @@ -271,11 +303,20 @@ ], "responses": { "200": { - "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "description": "Success. The response describes a SignalR service.", "schema": { - "$ref": "#/definitions/PrivateEndpointConnection" + "$ref": "#/definitions/SignalRResource" + } + }, + "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 SignalR service is now updating and contains a Location header to query the operation result.." + }, "default": { "description": "An unexpected error occurred during the operation.", "schema": { @@ -283,9 +324,10 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "SignalRPrivateEndpointConnections_Update": { - "$ref": "./examples/SignalRPrivateEndpointConnections_Update.json" + "SignalR_CreateOrUpdate": { + "$ref": "./examples/SignalR_CreateOrUpdate.json" } } }, @@ -293,16 +335,9 @@ "tags": [ "SignalR" ], - "description": "Delete the specified private endpoint connection associated with a SignalR resource.", - "operationId": "SignalRPrivateEndpointConnections_Delete", + "description": "Operation to delete a SignalR service.", + "operationId": "SignalR_Delete", "parameters": [ - { - "name": "privateEndpointConnectionName", - "in": "path", - "description": "The name of the private endpoint connection associated with the SignalR resource.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -318,10 +353,10 @@ ], "responses": { "202": { - "description": "Success" + "description": "Accepted. The response indicates the delete operation is performed in the background." }, "204": { - "description": "Success. The response indicates the private endpoint connection is already deleted." + "description": "Success. The response indicates the resource is already deleted." }, "default": { "description": "An unexpected error occurred during the operation.", @@ -332,20 +367,27 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "SignalRPrivateEndpointConnections_Delete": { - "$ref": "./examples/SignalRPrivateEndpointConnections_Delete.json" + "SignalR_Delete": { + "$ref": "./examples/SignalR_Delete.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources": { - "get": { + }, + "patch": { "tags": [ "SignalR" ], - "description": "Get the private link resources that need to be created for a SignalR resource.", - "operationId": "SignalRPrivateLinkResources_List", + "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/SignalRResource" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -361,11 +403,14 @@ ], "responses": { "200": { - "description": "Success. The response describes a list of private link resources.", + "description": "Success. The response describes a SignalR service.", "schema": { - "$ref": "#/definitions/PrivateLinkResourceList" + "$ref": "#/definitions/SignalRResource" } }, + "202": { + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." + }, "default": { "description": "An unexpected error occurred during the operation.", "schema": { @@ -373,12 +418,10 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "SignalRPrivateLinkResources_List": { - "$ref": "./examples/SignalRPrivateLinkResources_List.json" + "SignalR_Update": { + "$ref": "./examples/SignalR_Update.json" } } } @@ -425,22 +468,20 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { "tags": [ "SignalR" ], - "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", - "operationId": "SignalR_RegenerateKey", + "description": "Get the specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Get", "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Parameter that describes the Regenerate Key Operation.", - "required": false, - "schema": { - "$ref": "#/definitions/RegenerateKeyParameters" - } + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -456,10 +497,10 @@ } ], "responses": { - "201": { - "description": "Created and an async operation is executing 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.", + "200": { + "description": "Success. The response describes a list of private link resources.", "schema": { - "$ref": "#/definitions/SignalRKeys" + "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { @@ -469,25 +510,35 @@ } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, "x-ms-examples": { - "SignalR_RegenerateKey": { - "$ref": "./examples/SignalR_RegenerateKey.json" + "SignalRPrivateEndpointConnections_Get": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}": { - "get": { + }, + "put": { "tags": [ "SignalR" ], - "description": "Get the SignalR service and its properties.", - "operationId": "SignalR_Get", + "description": "Update the state of specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Update", "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource of private endpoint and its properties.", + "required": false, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -503,9 +554,9 @@ ], "responses": { "200": { - "description": "Success. The response describes the corresponding SignalR service.", + "description": "OK. The response indicates the private endpoint connection is updated successfully.", "schema": { - "$ref": "#/definitions/SignalRResource" + "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { @@ -516,26 +567,24 @@ } }, "x-ms-examples": { - "SignalR_Get": { - "$ref": "./examples/SignalR_Get.json" + "SignalRPrivateEndpointConnections_Update": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Update.json" } } }, - "put": { + "delete": { "tags": [ "SignalR" ], - "description": "Create a new SignalR service and update an exiting SignalR service.", - "operationId": "SignalR_CreateOrUpdate", + "description": "Delete the specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Delete", "parameters": [ { - "name": "parameters", - "in": "body", - "description": "Parameters for the create or update operation", - "required": false, - "schema": { - "$ref": "#/definitions/SignalRResource" - } + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -551,20 +600,11 @@ } ], "responses": { - "200": { - "description": "Success. The response describes a SignalR service.", - "schema": { - "$ref": "#/definitions/SignalRResource" - } - }, - "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 SignalR service is now updating and contains a Location header to query the operation result.." + "description": "Success" + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." }, "default": { "description": "An unexpected error occurred during the operation.", @@ -575,17 +615,19 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "SignalR_CreateOrUpdate": { - "$ref": "./examples/SignalR_CreateOrUpdate.json" + "SignalRPrivateEndpointConnections_Delete": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Delete.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources": { + "get": { "tags": [ "SignalR" ], - "description": "Operation to delete a SignalR service.", - "operationId": "SignalR_Delete", + "description": "Get the private link resources that need to be created for a SignalR resource.", + "operationId": "SignalRPrivateLinkResources_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -601,11 +643,11 @@ } ], "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." + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } }, "default": { "description": "An unexpected error occurred during the operation.", @@ -614,27 +656,31 @@ } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "SignalR_Delete": { - "$ref": "./examples/SignalR_Delete.json" + "SignalRPrivateLinkResources_List": { + "$ref": "./examples/SignalRPrivateLinkResources_List.json" } } - }, - "patch": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey": { + "post": { "tags": [ "SignalR" ], - "description": "Operation to update an exiting SignalR service.", - "operationId": "SignalR_Update", + "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": "Parameters for the update operation", + "description": "Parameter that describes the Regenerate Key Operation.", "required": false, "schema": { - "$ref": "#/definitions/SignalRResource" + "$ref": "#/definitions/RegenerateKeyParameters" } }, { @@ -651,15 +697,12 @@ } ], "responses": { - "200": { - "description": "Success. The response describes a SignalR service.", + "201": { + "description": "Created and an async operation is executing 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/SignalRResource" + "$ref": "#/definitions/SignalRKeys" } }, - "202": { - "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." - }, "default": { "description": "An unexpected error occurred during the operation.", "schema": { @@ -668,9 +711,12 @@ } }, "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "x-ms-examples": { - "SignalR_Update": { - "$ref": "./examples/SignalR_Update.json" + "SignalR_RegenerateKey": { + "$ref": "./examples/SignalR_RegenerateKey.json" } } } @@ -720,164 +766,184 @@ } } } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { - "get": { - "tags": [ - "SignalR" - ], - "description": "List usage quotas for Azure SignalR service by location.", - "operationId": "Usages_List", - "parameters": [ - { - "name": "location", - "in": "path", - "description": "the location like \"eastus\"", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describe the usage quotas of a subscription in specified region.", - "schema": { - "$ref": "#/definitions/SignalRUsageList" - } - }, - "default": { - "description": "An unexpected error occurred during the operation.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Usages_List": { - "$ref": "./examples/Usages_List.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" - } + "ACLAction": { + "description": "Default action when no other rule matches", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true } }, - "Operation": { - "description": "REST API operation supported by SignalR resource provider.", + "Dimension": { + "description": "Specifications of the Dimension of metrics.", "type": "object", "properties": { "name": { - "description": "Name of the operation with format: {provider}/{resource}/{operation}", - "type": "string" - }, - "isDataAction": { - "description": "If the operation is a data action. (for data plane rbac)", - "type": "boolean" - }, - "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", + "description": "The public facing name of the dimension.", "type": "string" }, - "resource": { - "description": "Resource type on which the operation is performed.", + "displayName": { + "description": "Localized friendly display name of the dimension.", "type": "string" }, - "operation": { - "description": "The localized friendly name for the operation.", + "internalName": { + "description": "Name of the dimension as it appears in MDM.", "type": "string" }, - "description": { - "description": "The localized friendly description for the operation", - "type": "string" + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" } } }, - "OperationProperties": { - "description": "Extra Operation properties.", + "ErrorResponse": { + "description": "Contains information about an API error.", "type": "object", "properties": { - "serviceSpecification": { - "$ref": "#/definitions/ServiceSpecification", - "description": "The service specifications." + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "Describes a particular API error with an error code and a message." } } }, - "ServiceSpecification": { - "description": "An object that describes a specification.", + "ErrorResponseBody": { + "description": "Describes a particular API error with an error code and a message.", + "required": [ + "code", + "message" + ], "type": "object", "properties": { - "metricSpecifications": { - "description": "Specifications of the Metrics for Azure Monitoring.", - "type": "array", - "items": { - "$ref": "#/definitions/MetricSpecification" - } + "code": { + "description": "An error code that describes the error condition more precisely than an HTTP status code. \r\nCan be used to programmatically handle specific error cases.", + "type": "string" }, - "logSpecifications": { - "description": "Specifications of the Logs for Azure Monitoring.", + "message": { + "description": "A message that describes the error in detail and provides debugging information.", + "type": "string" + }, + "target": { + "description": "The target of the particular error (for example, the name of the property in error).", + "type": "string" + }, + "details": { + "description": "Contains nested errors that are related to this error.", "type": "array", "items": { - "$ref": "#/definitions/LogSpecification" + "$ref": "#/definitions/ErrorResponseBody" } } } }, - "MetricSpecification": { - "description": "Specifications of the Metrics for Azure Monitoring.", + "FeatureFlags": { + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.", + "enum": [ + "ServiceMode", + "EnableConnectivityLogs", + "EnableMessagingLogs" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureFlags", + "modelAsString": true + } + }, + "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 + } + }, + "LogSpecification": { + "description": "Specifications of the Logs for Azure Monitoring.", "type": "object", "properties": { "name": { - "description": "Name of the metric.", + "description": "Name of the log.", "type": "string" }, "displayName": { - "description": "Localized friendly display name of the metric.", + "description": "Localized friendly display name of the log.", "type": "string" - }, - "displayDescription": { + } + } + }, + "ManagedIdentity": { + "description": "A class represent managed identities used for request and response", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityType", + "description": "Represent the identity type: systemAssigned, userAssigned, None" + }, + "userAssignedIdentities": { + "description": "Get or set the user assigned identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperty" + } + }, + "principalId": { + "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentitySettings": { + "description": "Managed identity settings for upstream.", + "type": "object", + "properties": { + "resource": { + "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", + "type": "string" + } + } + }, + "ManagedIdentityType": { + "description": "Represent the identity type: systemAssigned, userAssigned, None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": 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" }, @@ -906,126 +972,120 @@ } } }, - "LogSpecification": { - "description": "Specifications of the Logs for Azure Monitoring.", + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", "type": "object", "properties": { - "name": { - "description": "Name of the log.", + "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" }, - "displayName": { - "description": "Localized friendly display name of the log.", + "message": { + "description": "The message of the operation.", "type": "string" } } }, - "Dimension": { - "description": "Specifications of the Dimension of metrics.", + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "type", + "name" + ], "type": "object", "properties": { - "name": { - "description": "The public facing name of the dimension.", - "type": "string" - }, - "displayName": { - "description": "Localized friendly display name of the dimension.", + "type": { + "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", "type": "string" }, - "internalName": { - "description": "Name of the dimension as it appears in MDM.", + "name": { + "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", "type": "string" - }, - "toBeExportedForShoebox": { - "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", - "type": "boolean" } } }, - "ErrorResponse": { - "description": "Contains information about an API error.", + "NetworkACL": { + "description": "Network ACL", "type": "object", "properties": { - "error": { - "$ref": "#/definitions/ErrorResponseBody", - "description": "Describes a particular API error with an error code and a message." + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + } + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + } } } }, - "ErrorResponseBody": { - "description": "Describes a particular API error with an error code and a message.", - "required": [ - "code", - "message" - ], + "Operation": { + "description": "REST API operation supported by SignalR resource provider.", "type": "object", "properties": { - "code": { - "description": "An error code that describes the error condition more precisely than an HTTP status code. \r\nCan be used to programmatically handle specific error cases.", + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", "type": "string" }, - "message": { - "description": "A message that describes the error in detail and provides debugging information.", - "type": "string" + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" }, - "target": { - "description": "The target of the particular error (for example, the name of the property in error).", + "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" }, - "details": { - "description": "Contains nested errors that are related to this error.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorResponseBody" - } + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false } } }, - "NameAvailabilityParameters": { - "description": "Data POST-ed to the nameAvailability action", - "required": [ - "type", - "name" - ], + "OperationDisplay": { + "description": "The object that describes a operation.", "type": "object", "properties": { - "type": { - "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", + "provider": { + "description": "Friendly name of the resource provider", "type": "string" }, - "name": { - "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", + "resource": { + "description": "Resource type on which the operation is performed.", "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.", + "operation": { + "description": "The localized friendly name for the operation.", "type": "string" }, - "message": { - "description": "The message of the operation.", + "description": { + "description": "The localized friendly description for the operation", "type": "string" } } }, - "SignalRResourceList": { - "description": "Object that includes an array of SignalR services and a possible link for next set.", + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", "type": "object", "properties": { "value": { - "description": "List of SignalR services", + "description": "List of operations supported by the resource provider.", "type": "array", "items": { - "$ref": "#/definitions/SignalRResource" + "$ref": "#/definitions/Operation" } }, "nextLink": { @@ -1034,73 +1094,204 @@ } } }, - "SignalRResource": { - "description": "A class represent a SignalR service resource.", + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], "type": "object", "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "#/definitions/NetworkACL" } ], "properties": { - "sku": { - "$ref": "#/definitions/ResourceSku", - "description": "The billing information of the resource.(e.g. Free, Standard)" - }, - "properties": { - "$ref": "#/definitions/SignalRProperties", - "description": "Settings used to provision or configure the resource", - "x-ms-client-flatten": true - }, - "kind": { - "$ref": "#/definitions/ServiceKind", - "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "identity": { - "$ref": "#/definitions/ManagedIdentity", - "description": "The managed identity response" + "name": { + "description": "Name of the private endpoint connection", + "type": "string" } } }, - "ServiceKind": { - "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"", + "PrivateEndpointConnection": { + "description": "A private endpoint connection to SignalR resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the private endpoint connection", + "x-ms-client-flatten": true + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the private endpoint connection", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Private endpoint associated with the private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Connection state" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of a private link resource", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of AzSignalR.Models.Response.PrivateLink.PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "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" + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", "enum": [ - "SignalR", - "RawWebSockets" + "Pending", + "Approved", + "Rejected", + "Disconnected" ], "type": "string", "x-ms-enum": { - "name": "ServiceKind", + "name": "PrivateLinkServiceConnectionStatus", "modelAsString": true } }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource.", + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": {} + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", "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" - } + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)." } } }, @@ -1158,96 +1349,66 @@ } } }, - "SignalRSkuTier": { - "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", - "enum": [ - "Free", - "Basic", - "Standard", - "Premium" - ], - "type": "string", - "x-ms-enum": { - "name": "SignalRSkuTier", - "modelAsString": true - } - }, - "SignalRProperties": { - "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties", + "ServerlessUpstreamSettings": { + "description": "The settings for the Upstream when the Azure SignalR is in server-less mode.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SignalRCreateOrUpdateProperties" - } - ], "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning state of the resource.", - "readOnly": 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 accessible port of the SignalR service which is designed for browser/client side usage.", - "type": "integer", - "readOnly": true - }, - "serverPort": { - "format": "int32", - "description": "The publicly accessible port of the SignalR service which is designed for customer server side usage.", - "type": "integer", - "readOnly": true - }, - "version": { - "description": "Version of the SignalR resource. Probably you need the same or higher version of client SDKs.", - "type": "string", - "readOnly": true - }, - "privateEndpointConnections": { - "description": "Private endpoint connections to the SignalR resource.", + "templates": { + "description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.", "type": "array", "items": { - "$ref": "#/definitions/PrivateEndpointConnection" - }, - "readOnly": true - }, - "tls": { - "$ref": "#/definitions/SignalRTlsSettings", - "description": "TLS settings." + "$ref": "#/definitions/UpstreamTemplate" + } } } }, - "ProvisioningState": { - "description": "Provisioning state of the resource.", + "ServiceKind": { + "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"", "enum": [ - "Unknown", - "Succeeded", - "Failed", - "Canceled", - "Running", - "Creating", - "Updating", - "Deleting", - "Moving" + "SignalR", + "RawWebSockets" ], "type": "string", "x-ms-enum": { - "name": "ProvisioningState", + "name": "ServiceKind", "modelAsString": true } }, - "SignalRCreateOrUpdateProperties": { - "description": "Settings used to provision or configure the resource.", + "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" + } + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "SignalRCorsSettings": { + "description": "Cross-Origin Resource Sharing (CORS) settings.", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use \"*\" to allow all. If omitted, allow all by default.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SignalRCreateOrUpdateProperties": { + "description": "Settings used to provision or configure the resource.", "type": "object", "properties": { "features": { @@ -1298,42 +1459,25 @@ } } }, - "FeatureFlags": { - "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.", - "enum": [ - "ServiceMode", - "EnableConnectivityLogs", - "EnableMessagingLogs" - ], - "type": "string", - "x-ms-enum": { - "name": "FeatureFlags", - "modelAsString": true - } - }, - "SignalRCorsSettings": { - "description": "Cross-Origin Resource Sharing (CORS) settings.", - "type": "object", - "properties": { - "allowedOrigins": { - "description": "Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use \"*\" to allow all. If omitted, allow all by default.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ServerlessUpstreamSettings": { - "description": "The settings for the Upstream when the Azure SignalR is in server-less mode.", + "SignalRKeys": { + "description": "A class represents the access keys of SignalR service.", "type": "object", "properties": { - "templates": { - "description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.", - "type": "array", - "items": { - "$ref": "#/definitions/UpstreamTemplate" - } + "primaryKey": { + "description": "The primary access key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string" + }, + "primaryConnectionString": { + "description": "SignalR connection string constructed via the primaryKey", + "type": "string" + }, + "secondaryConnectionString": { + "description": "SignalR connection string constructed via the secondaryKey", + "type": "string" } } }, @@ -1359,64 +1503,58 @@ } } }, - "ACLAction": { - "description": "Default action when no other rule matches", - "enum": [ - "Allow", - "Deny" - ], - "type": "string", - "x-ms-enum": { - "name": "ACLAction", - "modelAsString": true - } - }, - "UpstreamTemplate": { - "description": "Upstream template item settings. It defines the Upstream URL of the incoming requests.\r\nThe template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.", - "required": [ - "urlTemplate" - ], + "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": { - "hubPattern": { - "description": "Gets or sets the matching pattern for hub names. If not set, it matches any hub.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any hub name\r\n 2. Combine multiple hubs with \",\", for example \"hub1,hub2\", it matches \"hub1\" and \"hub2\"\r\n 3. The single hub name, for example, \"hub1\", it matches \"hub1\"", - "type": "string" + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true }, - "eventPattern": { - "description": "Gets or sets the matching pattern for event names. If not set, it matches any event.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name\r\n 2. Combine multiple events with \",\", for example \"connect,disconnect\", it matches event \"connect\" and \"disconnect\"\r\n 3. The single event name, for example, \"connect\", it matches \"connect\"", - "type": "string" + "externalIP": { + "description": "The publicly accessible IP of the SignalR service.", + "type": "string", + "readOnly": true }, - "categoryPattern": { - "description": "Gets or sets the matching pattern for category names. If not set, it matches any category.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any category name\r\n 2. Combine multiple categories with \",\", for example \"connections,messages\", it matches category \"connections\" and \"messages\"\r\n 3. The single category name, for example, \"connections\", it matches the category \"connections\"", - "type": "string" + "hostName": { + "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net", + "type": "string", + "readOnly": true }, - "urlTemplate": { - "description": "Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.\r\nFor example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.", - "type": "string" + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the SignalR service which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true }, - "auth": { - "$ref": "#/definitions/UpstreamAuthSettings", - "description": "Gets or sets the auth settings for an upstream. If not set, no auth is used for upstream messages." - } - } - }, - "NetworkACL": { - "description": "Network ACL", - "type": "object", - "properties": { - "allow": { - "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", - "type": "array", - "items": { - "$ref": "#/definitions/SignalRRequestType" - } + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the SignalR service which is designed for customer server side usage.", + "type": "integer", + "readOnly": true }, - "deny": { - "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "version": { + "description": "Version of the SignalR resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the SignalR resource.", "type": "array", "items": { - "$ref": "#/definitions/SignalRRequestType" - } + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "tls": { + "$ref": "#/definitions/SignalRTlsSettings", + "description": "TLS settings." } } }, @@ -1433,370 +1571,232 @@ "modelAsString": true } }, - "PrivateEndpointACL": { - "description": "ACL for a private endpoint", - "required": [ - "name" - ], + "SignalRResource": { + "description": "A class represent a SignalR service resource.", "type": "object", "allOf": [ { - "$ref": "#/definitions/NetworkACL" + "$ref": "#/definitions/TrackedResource" } ], "properties": { - "name": { - "description": "Name of the private endpoint connection", - "type": "string" + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. Free, Standard)" + }, + "properties": { + "$ref": "#/definitions/SignalRProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": true + }, + "kind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "#/definitions/ManagedIdentity", + "description": "The managed identity response" } } }, - "UpstreamAuthSettings": { - "description": "Upstream auth settings.", + "SignalRResourceList": { + "description": "Object that includes an array of SignalR services and a possible link for next set.", "type": "object", "properties": { - "type": { - "$ref": "#/definitions/UpstreamAuthType", - "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now." + "value": { + "description": "List of SignalR services", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRResource" + } }, - "managedIdentity": { - "$ref": "#/definitions/ManagedIdentitySettings", - "description": "Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity." + "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" } } }, - "UpstreamAuthType": { - "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now.", + "SignalRSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", "enum": [ - "None", - "ManagedIdentity" + "Free", + "Basic", + "Standard", + "Premium" ], "type": "string", "x-ms-enum": { - "name": "UpstreamAuthType", + "name": "SignalRSkuTier", "modelAsString": true } }, - "ManagedIdentitySettings": { - "description": "Managed identity settings for upstream.", + "SignalRTlsSettings": { + "description": "TLS settings for SignalR", "type": "object", "properties": { - "resource": { - "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", - "type": "string" + "clientCertEnabled": { + "description": "Request client certificate during TLS handshake if enabled", + "type": "boolean" } } }, - "ManagedIdentity": { - "description": "A class represent managed identities used for request and response", + "SignalRUsage": { + "description": "Object that describes a specific usage of SignalR resources.", "type": "object", "properties": { - "type": { - "$ref": "#/definitions/ManagedIdentityType", - "description": "Represent the identity type: systemAssigned, userAssigned, None" - }, - "userAssignedIdentities": { - "description": "Get or set the user assigned identities", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/UserAssignedIdentityProperty" - } - }, - "principalId": { - "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", - "type": "string", - "readOnly": true + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" }, - "tenantId": { - "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", - "type": "string", - "readOnly": true - } - } - }, - "ManagedIdentityType": { - "description": "Represent the identity type: systemAssigned, userAssigned, None", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "ManagedIdentityType", - "modelAsString": true - } - }, - "PrivateEndpointConnection": { - "description": "A private endpoint connection to SignalR resource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/PrivateEndpointConnectionProperties", - "description": "Properties of the private endpoint connection", - "x-ms-client-flatten": true - } - } - }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": {} - }, - "SignalRTlsSettings": { - "description": "TLS settings for SignalR", - "type": "object", - "properties": { - "clientCertEnabled": { - "description": "Request client certificate during TLS handshake if enabled", - "type": "boolean" - } - } - }, - "UserAssignedIdentityProperty": { - "description": "Properties of user assigned identity.", - "type": "object", - "properties": { - "principalId": { - "description": "Get the principal id for the user assigned identity", - "type": "string", - "readOnly": true + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" }, - "clientId": { - "description": "Get the client id for the user assigned identity", - "type": "string", - "readOnly": true - } - } - }, - "PrivateEndpointConnectionProperties": { - "description": "Private endpoint connection properties", - "type": "object", - "properties": { - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning state of the private endpoint connection", - "readOnly": true + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" }, - "privateEndpoint": { - "$ref": "#/definitions/PrivateEndpoint", - "description": "Private endpoint associated with the private endpoint connection" + "name": { + "$ref": "#/definitions/SignalRUsageName", + "description": "Localizable String object containing the name and a localized value." }, - "privateLinkServiceConnectionState": { - "$ref": "#/definitions/PrivateLinkServiceConnectionState", - "description": "Connection state" - } - } - }, - "PrivateEndpoint": { - "description": "Private endpoint", - "type": "object", - "properties": { - "id": { - "description": "Full qualified Id of the private endpoint", + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", "type": "string" } } }, - "PrivateLinkServiceConnectionState": { - "description": "Connection state of the private endpoint connection", + "SignalRUsageList": { + "description": "Object that includes an array of SignalR resource usages and a possible link for next set.", "type": "object", "properties": { - "status": { - "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", - "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." - }, - "description": { - "description": "The reason for approval/rejection of the connection.", - "type": "string" + "value": { + "description": "List of SignalR usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRUsage" + } }, - "actionsRequired": { - "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "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" } } }, - "PrivateLinkServiceConnectionStatus": { - "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", - "enum": [ - "Pending", - "Approved", - "Rejected", - "Disconnected" - ], - "type": "string", - "x-ms-enum": { - "name": "PrivateLinkServiceConnectionStatus", - "modelAsString": true - } - }, - "PrivateLinkResourceList": { - "description": "Contains a list of AzSignalR.Models.Response.PrivateLink.PrivateLinkResource and a possible link to query more results", + "SignalRUsageName": { + "description": "Localizable String object containing the name and a localized value.", "type": "object", "properties": { "value": { - "description": "List of PrivateLinkResource", - "type": "array", - "items": { - "$ref": "#/definitions/PrivateLinkResource" - } + "description": "The identifier of the usage.", + "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.", + "localizedValue": { + "description": "Localized name of the usage.", "type": "string" } } }, - "PrivateLinkResource": { - "description": "Private link resource", + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "#/definitions/Resource" } ], "properties": { - "properties": { - "$ref": "#/definitions/PrivateLinkResourceProperties", - "description": "Properties of a private link resource", - "x-ms-client-flatten": true - } - } - }, - "PrivateLinkResourceProperties": { - "description": "Private link resource properties", - "type": "object", - "properties": { - "groupId": { - "description": "Group Id of the private link resource", - "type": "string" - }, - "requiredMembers": { - "description": "Required members of the private link resource", - "type": "array", - "items": { - "type": "string" - } + "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" + ] }, - "requiredZoneNames": { - "description": "Required private DNS zone names", - "type": "array", - "items": { + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { "type": "string" } } } }, - "SignalRKeys": { - "description": "A class represents the access keys of SignalR service.", + "UpstreamAuthSettings": { + "description": "Upstream auth settings.", "type": "object", "properties": { - "primaryKey": { - "description": "The primary access key.", - "type": "string" - }, - "secondaryKey": { - "description": "The secondary access key.", - "type": "string" - }, - "primaryConnectionString": { - "description": "SignalR connection string constructed via the primaryKey", - "type": "string" + "type": { + "$ref": "#/definitions/UpstreamAuthType", + "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now." }, - "secondaryConnectionString": { - "description": "SignalR connection string constructed via the secondaryKey", - "type": "string" - } - } - }, - "RegenerateKeyParameters": { - "description": "Parameters describes the request to regenerate access keys", - "type": "object", - "properties": { - "keyType": { - "$ref": "#/definitions/KeyType", - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)." + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentitySettings", + "description": "Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity." } } }, - "KeyType": { - "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "UpstreamAuthType": { + "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now.", "enum": [ - "Primary", - "Secondary" + "None", + "ManagedIdentity" ], "type": "string", "x-ms-enum": { - "name": "KeyType", + "name": "UpstreamAuthType", "modelAsString": true } }, - "SignalRUsageList": { - "description": "Object that includes an array of SignalR resource usages and a possible link for next set.", - "type": "object", - "properties": { - "value": { - "description": "List of SignalR usages", - "type": "array", - "items": { - "$ref": "#/definitions/SignalRUsage" - } - }, - "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" - } - } - }, - "SignalRUsage": { - "description": "Object that describes a specific usage of SignalR resources.", + "UpstreamTemplate": { + "description": "Upstream template item settings. It defines the Upstream URL of the incoming requests.\r\nThe template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.", + "required": [ + "urlTemplate" + ], "type": "object", "properties": { - "id": { - "description": "Fully qualified ARM resource id", + "hubPattern": { + "description": "Gets or sets the matching pattern for hub names. If not set, it matches any hub.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any hub name\r\n 2. Combine multiple hubs with \",\", for example \"hub1,hub2\", it matches \"hub1\" and \"hub2\"\r\n 3. The single hub name, for example, \"hub1\", it matches \"hub1\"", "type": "string" }, - "currentValue": { - "format": "int64", - "description": "Current value for the usage quota.", - "type": "integer" - }, - "limit": { - "format": "int64", - "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", - "type": "integer" + "eventPattern": { + "description": "Gets or sets the matching pattern for event names. If not set, it matches any event.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name\r\n 2. Combine multiple events with \",\", for example \"connect,disconnect\", it matches event \"connect\" and \"disconnect\"\r\n 3. The single event name, for example, \"connect\", it matches \"connect\"", + "type": "string" }, - "name": { - "$ref": "#/definitions/SignalRUsageName", - "description": "Localizable String object containing the name and a localized value." + "categoryPattern": { + "description": "Gets or sets the matching pattern for category names. If not set, it matches any category.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any category name\r\n 2. Combine multiple categories with \",\", for example \"connections,messages\", it matches category \"connections\" and \"messages\"\r\n 3. The single category name, for example, \"connections\", it matches the category \"connections\"", + "type": "string" }, - "unit": { - "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "urlTemplate": { + "description": "Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.\r\nFor example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.", "type": "string" + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings", + "description": "Gets or sets the auth settings for an upstream. If not set, no auth is used for upstream messages." } } }, - "SignalRUsageName": { - "description": "Localizable String object containing the name and a localized value.", + "UserAssignedIdentityProperty": { + "description": "Properties of user assigned identity.", "type": "object", "properties": { - "value": { - "description": "The identifier of the usage.", - "type": "string" + "principalId": { + "description": "Get the principal id for the user assigned identity", + "type": "string", + "readOnly": true }, - "localizedValue": { - "description": "Localized name of the usage.", - "type": "string" + "clientId": { + "description": "Get the client id for the user assigned identity", + "type": "string", + "readOnly": true } } }