openapi-directory/api/azure.com/signalr.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"REST API for Azure SignalR Service","title":"SignalRManagementClient","version":"2018-10-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"signalr","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.SignalRService/operations":{"get":{"description":"Lists all of the available REST API operations of the Microsoft.SignalRService provider.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Success. The response describes the list of operations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationList"},"examples":{"Operations_List":{"$ref":"#/components/examples/Operations_List"}}}}},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/SignalR":{"get":{"description":"Handles requests to list all resources in a subscription.","operationId":"SignalR_ListBySubscription","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"Success. The response describes the list of SignalR services in the subscription.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRResourceList"},"examples":{"SignalR_ListBySubscription":{"$ref":"#/components/examples/SignalR_ListBySubscription"}}}}},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability":{"post":{"description":"Checks that the SignalR name is valid and is not already in use.","operationId":"SignalR_CheckNameAvailability","parameters":[{"description":"the region","in":"path","name":"location","required":true,"schema":{"type":"string"},"examples":{"SignalR_CheckNameAvailability":{"value":"eastus"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameAvailabilityParameters"}}},"description":"Parameters supplied to the operation."},"responses":{"200":{"description":"Success. The response describes the name availability.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameAvailability"},"examples":{"SignalR_CheckNameAvailability":{"$ref":"#/components/examples/SignalR_CheckNameAvailability"}}}}},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages":{"get":{"description":"List usage quotas for Azure SignalR service by location.","operationId":"Usages_List","parameters":[{"description":"the location like \"eastus\"","in":"path","name":"location","required":true,"schema":{"type":"string"},"examples":{"Usages_List":{"value":"eastus"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"Success. The response describe the usage quotas of a subscription in specified region.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRUsageList"},"examples":{"Usages_List":{"$ref":"#/components/examples/Usages_List"}}}}},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR":{"get":{"description":"Handles requests to list all resources in a resource group.","operationId":"SignalR_ListByResourceGroup","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"}],"responses":{"200":{"description":"Success. The response describes the list of SignalR services in a resourceGroup.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRResourceList"},"examples":{"SignalR_ListByResourceGroup":{"$ref":"#/components/examples/SignalR_ListByResourceGroup"}}}}},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/listKeys":{"post":{"description":"Get the access keys of the SignalR resource.","operationId":"SignalR_ListKeys","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/SignalRServiceName"}],"responses":{"200":{"description":"Success. The response describes SignalR service access keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRKeys"},"examples":{"SignalR_ListKeys":{"$ref":"#/components/examples/SignalR_ListKeys"}}}}},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/regenerateKey":{"post":{"description":"Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.","operationId":"SignalR_RegenerateKey","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/SignalRServiceName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegenerateKeyParameters"}}},"description":"Parameter that describes the Regenerate Key Operation."},"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRKeys"},"examples":{"SignalR_RegenerateKey":{"$ref":"#/components/examples/SignalR_RegenerateKey"}}}}},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}":{"delete":{"description":"Operation to delete a SignalR service.","operationId":"SignalR_Delete","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/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."},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-long-running-operation":true},"get":{"description":"Get the SignalR service and its properties.","operationId":"SignalR_Get","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/SignalRServiceName"}],"responses":{"200":{"description":"Success. The response describes the corresponding SignalR service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRResource"},"examples":{"SignalR_Get":{"$ref":"#/components/examples/SignalR_Get"}}}}},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"]},"patch":{"description":"Operation to update an exiting SignalR service.","operationId":"SignalR_Update","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/SignalRServiceName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRUpdateParameters"}}},"description":"Parameters for the update operation"},"responses":{"200":{"description":"Success. The response describes a SignalR service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRResource"},"examples":{"SignalR_Update":{"$ref":"#/components/examples/SignalR_Update"}}}}},"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-long-running-operation":true},"put":{"description":"Create a new SignalR service and update an exiting SignalR service.","operationId":"SignalR_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/SignalRServiceName"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRCreateParameters"}}},"description":"Parameters for the create or update operation"},"responses":{"200":{"description":"Success. The response describes a SignalR service.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRResource"},"examples":{"SignalR_CreateOrUpdate":{"$ref":"#/components/examples/SignalR_CreateOrUpdate"}}}}},"201":{"description":"Created. The response describes the new service and contains a Location header to query the operation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalRResource"},"examples":{"SignalR_CreateOrUpdate":{"$ref":"#/components/examples/SignalR_CreateOrUpdate"}}}}},"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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart":{"post":{"description":"Operation to restart a SignalR service.","operationId":"SignalR_Restart","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/SignalRServiceName"}],"responses":{"202":{"description":"Accepted. The response indicates the restart operation is performed in the background."},"204":{"description":"Success. The response indicates the operation is successful and no content will be returned."},"default":{"description":"An unexpected error occurred during the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["SignalR"],"x-ms-long-running-operation":true,"x-ms-long-running-operation-options":{"final-state-via":"azure-async-operation"}}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Operations_List":{"value":{"nextLink":"providers/Microsoft.SignalRService?$skipToken={opaqueString}","value":[{"display":{"description":"View the SignalR's settings and configurations in the management portal or through API","operation":"Manage SignalR (read-only)","provider":"Microsoft.SignalRService","resource":"SignalR"},"name":"Microsoft.SignalRService/SignalR/read","properties":{}}]}},"SignalR_ListBySubscription":{"value":{"value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService","location":"eastus","name":"mySignalRService","properties":{"cors":{"allowedOrigins":["https://foo.com","https://bar.com"]},"externalIP":"10.0.0.1","features":[{"flag":"ServiceMode","properties":{},"value":"Serverless"}],"hostName":"mysignalrservice.service.signalr.net","provisioningState":"Succeeded","publicPort":443,"serverPort":443,"version":"1.0"},"sku":{"capacity":1,"name":"Standard_S1","size":"S1","tier":"Standard"},"tags":{"key1":"value1"},"type":"Microsoft.SignalRService/SignalR"}]}},"SignalR_CheckNameAvailability":{"value":{"message":"The leaf is already used by other people","nameAvailable":false,"reason":"AlreadyExists"}},"Usages_List":{"value":{"nextLink":"https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults...","value":[{"currentValue":0,"id":"/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1","limit":100,"name":{"localizedValue":"Usage1","value":"Usage1"},"unit":"Count"},{"currentValue":0,"id":"/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2","limit":100,"name":{"localizedValue":"Usage2","value":"Usage2"},"unit":"Count"}]}},"SignalR_ListByResourceGroup":{"value":{"value":[{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService","location":"eastus","name":"mySignalRService","properties":{"cors":{"allowedOrigins":["https://foo.com","https://bar.com"]},"externalIP":"10.0.0.1","features":[{"flag":"ServiceMode","properties":{},"value":"Serverless"}],"hostName":"mysignalrservice.service.signalr.net","provisioningState":"Succeeded","publicPort":443,"serverPort":443,"version":"1.0"},"sku":{"capacity":1,"name":"Standard_S1","size":"S1","tier":"Standard"},"tags":{"key1":"value1"},"type":"Microsoft.SignalRService/SignalR"}]}},"SignalR_ListKeys":{"value":{"primaryConnectionString":"Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0","primaryKey":"primaryAccessKey","secondaryConnectionString":"Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0","secondaryKey":"secondaryAccessKey"}},"SignalR_RegenerateKey":{"value":{"primaryConnectionString":"Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0;","primaryKey":"primaryAccessKey","secondaryConnectionString":"Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0;","secondaryKey":"secondaryAccessKey"}},"SignalR_Get":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService","location":"eastus","name":"mySignalRService","properties":{"cors":{"allowedOrigins":["https://foo.com","https://bar.com"]},"externalIP":"10.0.0.1","features":[{"flag":"ServiceMode","properties":{},"value":"Serverless"}],"hostName":"mysignalrservice.service.signalr.net","provisioningState":"Succeeded","publicPort":443,"serverPort":443,"version":"1.0"},"sku":{"capacity":1,"name":"Standard_S1","size":"S1","tier":"Standard"},"tags":{"key1":"value1"},"type":"Microsoft.SignalRService/SignalR"}},"SignalR_Update":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService","location":"eastus","name":"mySignalRService","properties":{"cors":{"allowedOrigins":["https://foo.com","https://bar.com"]},"externalIP":"10.0.0.1","features":[{"flag":"ServiceMode","properties":{},"value":"Serverless"}],"hostName":"mysignalrservice.service.signalr.net","provisioningState":"Succeeded","publicPort":443,"serverPort":443,"version":"1.0"},"sku":{"capacity":1,"name":"Standard_S1","size":"S1","tier":"Standard"},"tags":{"key1":"value1"},"type":"Microsoft.SignalRService/SignalR"}},"SignalR_CreateOrUpdate":{"value":{"id":"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService","location":"eastus","name":"mySignalRService","properties":{"cors":{"allowedOrigins":["https://foo.com","https://bar.com"]},"externalIP":"10.0.0.1","features":[{"flag":"ServiceMode","properties":{},"value":"Serverless"}],"hostName":"mysignalrservice.service.signalr.net","provisioningState":"Succeeded","publicPort":443,"serverPort":443,"version":"1.0"},"sku":{"capacity":1,"name":"Standard_S1","size":"S1","tier":"Standard"},"tags":{"key1":"value1"},"type":"Microsoft.SignalRService/SignalR"}}},"parameters":{"ApiVersionParameter":{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Operations_List":{"value":"2018-10-01"},"SignalR_ListBySubscription":{"value":"2018-10-01"},"SignalR_CheckNameAvailability":{"value":"2018-10-01"},"Usages_List":{"value":"2018-10-01"},"SignalR_ListByResourceGroup":{"value":"2018-10-01"},"SignalR_ListKeys":{"value":"2018-10-01"},"SignalR_RegenerateKey":{"value":"2018-10-01"},"SignalR_Delete":{"value":"2018-10-01"},"SignalR_Get":{"value":"2018-10-01"},"SignalR_Update":{"value":"2018-10-01"},"SignalR_CreateOrUpdate":{"value":"2018-10-01"},"SignalR_Restart":{"value":"2018-10-01"}}},"ResourceGroupParameter":{"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.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"SignalR_ListByResourceGroup":{"value":"myResourceGroup"},"SignalR_ListKeys":{"value":"myResourceGroup"},"SignalR_RegenerateKey":{"value":"myResourceGroup"},"SignalR_Delete":{"value":"myResourceGroup"},"SignalR_Get":{"value":"myResourceGroup"},"SignalR_Update":{"value":"myResourceGroup"},"SignalR_CreateOrUpdate":{"value":"myResourceGroup"},"SignalR_Restart":{"value":"myResourceGroup"}}},"SignalRServiceName":{"description":"The name of the SignalR resource.","in":"path","name":"resourceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"SignalR_ListKeys":{"value":"mySignalRService"},"SignalR_RegenerateKey":{"value":"mySignalRService"},"SignalR_Delete":{"value":"mySignalRService"},"SignalR_Get":{"value":"mySignalRService"},"SignalR_Update":{"value":"mySignalRService"},"SignalR_CreateOrUpdate":{"value":"mySignalRService"},"SignalR_Restart":{"value":"mySignalRService"}}},"SubscriptionIdParameter":{"description":"Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"SignalR_ListBySubscription":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_CheckNameAvailability":{"value":"00000000-0000-0000-0000-000000000000"},"Usages_List":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_ListByResourceGroup":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_ListKeys":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_RegenerateKey":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_Delete":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_Get":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_Update":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_CreateOrUpdate":{"value":"00000000-0000-0000-0000-000000000000"},"SignalR_Restart":{"value":"00000000-0000-0000-0000-000000000000"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"Dimension":{"description":"Specifications of the Dimension of metrics.","properties":{"displayName":{"description":"Localized friendly display name of the dimension.","type":"string"},"internalName":{"description":"Name of the dimension as it appears in MDM.","type":"string"},"name":{"description":"The public facing name of the dimension.","type":"string"},"toBeExportedForShoebox":{"description":"A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.","type":"boolean"}},"type":"object"},"ErrorResponse":{"description":"Contains information about an API error.","properties":{"error":{"$ref":"#/components/schemas/ErrorResponseBody"}},"type":"object"},"ErrorResponseBody":{"description":"Describes a particular API error with an error code and a message.","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.","type":"string"},"details":{"description":"Contains nested errors that are related to this error.","items":{"$ref":"#/components/schemas/ErrorResponseBody"},"type":"array"},"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"}},"required":["code","message"],"type":"object"},"LogSpecification":{"description":"Specifications of the Logs for Azure Monitoring.","properties":{"displayName":{"description":"Localized friendly display name of the log.","type":"string"},"name":{"description":"Name of the log.","type":"string"}},"type":"object"},"MetricSpecification":{"description":"Specifications of the Metrics for Azure Monitoring.","properties":{"aggregationType":{"description":"Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.","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"},"dimensions":{"description":"The dimensions of the metrics.","items":{"$ref":"#/components/schemas/Dimension"},"type":"array"},"displayDescription":{"description":"Localized friendly description of the metric.","type":"string"},"displayName":{"description":"Localized friendly display name of the metric.","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"},"name":{"description":"Name of the metric.","type":"string"},"unit":{"description":"The unit that makes sense for the metric.","type":"string"}},"type":"object"},"NameAvailability":{"description":"Result of the request to check name availability. It contains a flag and possible reason of failure.","properties":{"message":{"description":"The message of the operation.","type":"string"},"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"}},"type":"object"},"NameAvailabilityParameters":{"description":"Data POST-ed to the nameAvailability action","properties":{"name":{"description":"The SignalR service name to validate. e.g.\"my-signalR-name-here\"","type":"string"},"type":{"description":"The resource type. Should be always \"Microsoft.SignalRService/SignalR\".","type":"string"}},"required":["type","name"],"type":"object"},"Operation":{"description":"REST API operation supported by SignalR resource provider.","properties":{"display":{"$ref":"#/components/schemas/OperationDisplay"},"name":{"description":"Name of the operation with format: {provider}/{resource}/{operation}","type":"string"},"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":"#/components/schemas/OperationProperties"}},"type":"object"},"OperationDisplay":{"description":"The object that describes a operation.","properties":{"description":{"description":"The localized friendly description for the operation","type":"string"},"operation":{"description":"The localized friendly name for the operation.","type":"string"},"provider":{"description":"Friendly name of the resource provider","type":"string"},"resource":{"description":"Resource type on which the operation is performed.","type":"string"}},"type":"object"},"OperationList":{"description":"Result of the request to list REST API operations. It contains a list of operations.","properties":{"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"},"value":{"description":"List of operations supported by the resource provider.","items":{"$ref":"#/components/schemas/Operation"},"type":"array"}},"type":"object"},"OperationProperties":{"description":"Extra Operation properties.","properties":{"serviceSpecification":{"$ref":"#/components/schemas/ServiceSpecification"}},"type":"object"},"RegenerateKeyParameters":{"description":"Parameters describes the request to regenerate access keys","properties":{"keyType":{"description":"The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).","enum":["Primary","Secondary"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"KeyType"}}},"type":"object"},"Resource":{"description":"The core properties of ARM resources.","properties":{"id":{"description":"Fully qualified resource Id for the resource.","readOnly":true,"type":"string"},"name":{"description":"The name of the resource.","readOnly":true,"type":"string"},"type":{"description":"The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true},"ResourceSku":{"description":"The billing information of the SignalR resource.","properties":{"capacity":{"description":"Optional, integer. The unit count of SignalR resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n    Free: 1\r\n    Standard: 1,2,5,10,20,50,100","format":"int32","type":"integer"},"family":{"description":"Optional string. For future use.","type":"string"},"name":{"description":"The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1","type":"string"},"size":{"description":"Optional string. For future use.","type":"string"},"tier":{"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":{"modelAsString":true,"name":"SignalRSkuTier"}}},"required":["name"],"type":"object"},"ServiceSpecification":{"description":"An object that describes a specification.","properties":{"logSpecifications":{"description":"Specifications of the Logs for Azure Monitoring.","items":{"$ref":"#/components/schemas/LogSpecification"},"type":"array"},"metricSpecifications":{"description":"Specifications of the Metrics for Azure Monitoring.","items":{"$ref":"#/components/schemas/MetricSpecification"},"type":"array"}},"type":"object"},"SignalRCorsSettings":{"description":"Cross-Origin Resource Sharing (CORS) settings.","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.","items":{"type":"string"},"type":"array"}},"type":"object"},"SignalRCreateOrUpdateProperties":{"description":"Settings used to provision or configure the resource.","properties":{"cors":{"$ref":"#/components/schemas/SignalRCorsSettings"},"features":{"description":"List of SignalR featureFlags. e.g. ServiceMode.\r\n\r\nFeatureFlags that are not included in the parameters for the update operation will not be modified.\r\nAnd the response will only include featureFlags that are explicitly set. \r\nWhen a featureFlag is not explicitly set, SignalR service will use its globally default value. \r\nBut keep in mind, the default value doesn't mean \"false\". It varies in terms of different FeatureFlags.","items":{"$ref":"#/components/schemas/SignalRFeature"},"type":"array"},"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"}},"type":"object"},"SignalRCreateParameters":{"allOf":[{"$ref":"#/components/schemas/SignalRUpdateParameters"}],"description":"Parameters for SignalR service create/update operation.\r\n\r\nKeep the same schema as AzSignalR.Models.SignalRResource","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"}},"required":["location"],"type":"object"},"SignalRFeature":{"description":"Feature of a SignalR resource, which controls the SignalR runtime behavior.","properties":{"flag":{"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"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"FeatureFlags"}},"properties":{"additionalProperties":{"type":"string"},"description":"Optional properties related to this feature.","type":"object"},"value":{"description":"Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.","maxLength":128,"minLength":1,"type":"string"}},"required":["flag","value"],"type":"object"},"SignalRKeys":{"description":"A class represents the access keys of SignalR service.","properties":{"primaryConnectionString":{"description":"SignalR connection string constructed via the primaryKey","type":"string"},"primaryKey":{"description":"The primary access key.","type":"string"},"secondaryConnectionString":{"description":"SignalR connection string constructed via the secondaryKey","type":"string"},"secondaryKey":{"description":"The secondary access key.","type":"string"}},"type":"object"},"SignalRProperties":{"allOf":[{"$ref":"#/components/schemas/SignalRCreateOrUpdateProperties"}],"description":"A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties","properties":{"externalIP":{"description":"The publicly accessible IP of the SignalR service.","readOnly":true,"type":"string"},"hostName":{"description":"FQDN of the SignalR service instance. Format: xxx.service.signalr.net","readOnly":true,"type":"string"},"provisioningState":{"description":"Provisioning state of the resource.","enum":["Unknown","Succeeded","Failed","Canceled","Running","Creating","Updating","Deleting","Moving"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"ProvisioningState"}},"publicPort":{"description":"The publicly accessible port of the SignalR service which is designed for browser/client side usage.","format":"int32","readOnly":true,"type":"integer"},"serverPort":{"description":"The publicly accessible port of the SignalR service which is designed for customer server side usage.","format":"int32","readOnly":true,"type":"integer"},"version":{"description":"Version of the SignalR resource. Probably you need the same or higher version of client SDKs.","type":"string"}},"type":"object"},"SignalRResource":{"allOf":[{"$ref":"#/components/schemas/TrackedResource"}],"description":"A class represent a SignalR service resource.","properties":{"id":{"description":"Fully qualified resource Id for the resource.","readOnly":true,"type":"string"},"name":{"description":"The name of the resource.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/SignalRProperties"},"sku":{"$ref":"#/components/schemas/ResourceSku"},"type":{"description":"The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"","readOnly":true,"type":"string"}},"type":"object"},"SignalRResourceList":{"description":"Object that includes an array of SignalR services and a possible link for next set.","properties":{"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"},"value":{"description":"List of SignalR services","items":{"$ref":"#/components/schemas/SignalRResource"},"type":"array"}},"type":"object"},"SignalRUpdateParameters":{"description":"Parameters for SignalR service update operation","properties":{"properties":{"$ref":"#/components/schemas/SignalRCreateOrUpdateProperties"},"sku":{"$ref":"#/components/schemas/ResourceSku"},"tags":{"additionalProperties":{"type":"string"},"description":"A list of key value pairs that describe the resource.","type":"object"}},"type":"object"},"SignalRUsage":{"description":"Object that describes a specific usage of SignalR resources.","properties":{"currentValue":{"description":"Current value for the usage quota.","format":"int64","type":"integer"},"id":{"description":"Fully qualified ARM resource id","type":"string"},"limit":{"description":"The maximum permitted value for the usage quota. If there is no limit, this value will be -1.","format":"int64","type":"integer"},"name":{"$ref":"#/components/schemas/SignalRUsageName"},"unit":{"description":"Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.","type":"string"}},"type":"object"},"SignalRUsageList":{"description":"Object that includes an array of SignalR resource usages and a possible link for next set.","properties":{"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"},"value":{"description":"List of SignalR usages","items":{"$ref":"#/components/schemas/SignalRUsage"},"type":"array"}},"type":"object"},"SignalRUsageName":{"description":"Localizable String object containing the name and a localized value.","properties":{"localizedValue":{"description":"Localized name of the usage.","type":"string"},"value":{"description":"The identifier of the usage.","type":"string"}},"type":"object"},"TrackedResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"The resource model definition for a ARM tracked top level 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":{"additionalProperties":{"type":"string"},"description":"Tags of the service which is a list of key value pairs that describe the resource.","type":"object","x-ms-mutability":["read","create","update"]}},"type":"object"}}}}