1215 строки
40 KiB
JSON
1215 строки
40 KiB
JSON
{
|
|
"id": "https://schema.management.azure.com/schemas/2023-02-01/Microsoft.SignalRService.json#",
|
|
"title": "Microsoft.SignalRService",
|
|
"description": "Microsoft SignalRService Resource Types",
|
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
"resourceDefinitions": {
|
|
"signalR": {
|
|
"description": "Microsoft.SignalRService/signalR",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"identity": {
|
|
"description": "A class represent managed identities used for request and response",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/ManagedIdentity"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"kind": {
|
|
"description": "The kind of the service, it can be SignalR or RawWebSockets",
|
|
"oneOf": [
|
|
{
|
|
"enum": [
|
|
"SignalR",
|
|
"RawWebSockets"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"location": {
|
|
"description": "The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the resource.",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "A class that describes the properties of the resource",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/SignalRProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"resources": {
|
|
"items": {
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/signalR_customDomains_childResource"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/signalR_customCertificates_childResource"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/signalR_privateEndpointConnections_childResource"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/signalR_sharedPrivateLinkResources_childResource"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"sku": {
|
|
"description": "The billing information of the resource.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/ResourceSku"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"tags": {
|
|
"description": "Tags of the service which is a list of key value pairs that describe the resource.",
|
|
"oneOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"Microsoft.SignalRService/signalR"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"signalR_customCertificates": {
|
|
"description": "Microsoft.SignalRService/signalR/customCertificates",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Custom certificate name",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "Custom certificate properties.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/CustomCertificateProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"Microsoft.SignalRService/signalR/customCertificates"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"signalR_customDomains": {
|
|
"description": "Microsoft.SignalRService/signalR/customDomains",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Custom domain name.",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "Properties of a custom domain.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/CustomDomainProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"Microsoft.SignalRService/signalR/customDomains"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"signalR_privateEndpointConnections": {
|
|
"description": "Microsoft.SignalRService/signalR/privateEndpointConnections",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the private endpoint connection",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "Private endpoint connection properties",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/PrivateEndpointConnectionProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"Microsoft.SignalRService/signalR/privateEndpointConnections"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"signalR_sharedPrivateLinkResources": {
|
|
"description": "Microsoft.SignalRService/signalR/sharedPrivateLinkResources",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the shared private link resource",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "Describes the properties of an existing Shared Private Link Resource",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/SharedPrivateLinkResourceProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"Microsoft.SignalRService/signalR/sharedPrivateLinkResources"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"definitions": {
|
|
"CustomCertificateProperties": {
|
|
"description": "Custom certificate properties.",
|
|
"properties": {
|
|
"keyVaultBaseUri": {
|
|
"description": "Base uri of the KeyVault that stores certificate.",
|
|
"type": "string"
|
|
},
|
|
"keyVaultSecretName": {
|
|
"description": "Certificate secret name.",
|
|
"type": "string"
|
|
},
|
|
"keyVaultSecretVersion": {
|
|
"description": "Certificate secret version.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"keyVaultBaseUri",
|
|
"keyVaultSecretName"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"CustomDomainProperties": {
|
|
"description": "Properties of a custom domain.",
|
|
"properties": {
|
|
"customCertificate": {
|
|
"description": "Reference to a resource.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/ResourceReference"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"domainName": {
|
|
"description": "The custom domain name.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"domainName",
|
|
"customCertificate"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"LiveTraceCategory": {
|
|
"description": "Live trace category configuration of a Microsoft.SignalRService resource.",
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Indicates whether or the live trace category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Gets or sets the live trace category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"LiveTraceConfiguration": {
|
|
"description": "Live trace configuration of a Microsoft.SignalRService resource.",
|
|
"properties": {
|
|
"categories": {
|
|
"description": "Gets or sets the list of category configurations.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/definitions/LiveTraceCategory"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"enabled": {
|
|
"default": "false",
|
|
"description": "Indicates whether or not enable live trace.\r\nWhen it's set to true, live trace client can connect to the service.\r\nOtherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in \"categories\".\r\nAvailable values: true, false.\r\nCase insensitive.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ManagedIdentity": {
|
|
"description": "A class represent managed identities used for request and response",
|
|
"properties": {
|
|
"type": {
|
|
"description": "Represents the identity type: systemAssigned, userAssigned, None",
|
|
"oneOf": [
|
|
{
|
|
"enum": [
|
|
"None",
|
|
"SystemAssigned",
|
|
"UserAssigned"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"userAssignedIdentities": {
|
|
"description": "Get or set the user assigned identities",
|
|
"oneOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"$ref": "#/definitions/UserAssignedIdentityProperty"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ManagedIdentitySettings": {
|
|
"description": "Managed identity settings for upstream.",
|
|
"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"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"NetworkACL": {
|
|
"description": "Network ACL",
|
|
"properties": {
|
|
"allow": {
|
|
"description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"enum": [
|
|
"ClientConnection",
|
|
"ServerConnection",
|
|
"RESTAPI",
|
|
"Trace"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"deny": {
|
|
"description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"enum": [
|
|
"ClientConnection",
|
|
"ServerConnection",
|
|
"RESTAPI",
|
|
"Trace"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"PrivateEndpoint": {
|
|
"description": "Private endpoint",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Full qualified Id of the private endpoint",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"PrivateEndpointACL": {
|
|
"description": "ACL for a private endpoint",
|
|
"properties": {
|
|
"allow": {
|
|
"description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"enum": [
|
|
"ClientConnection",
|
|
"ServerConnection",
|
|
"RESTAPI",
|
|
"Trace"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"deny": {
|
|
"description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"enum": [
|
|
"ClientConnection",
|
|
"ServerConnection",
|
|
"RESTAPI",
|
|
"Trace"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"description": "Name of the private endpoint connection",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"PrivateEndpointConnectionProperties": {
|
|
"description": "Private endpoint connection properties",
|
|
"properties": {
|
|
"privateEndpoint": {
|
|
"description": "Private endpoint",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/PrivateEndpoint"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"privateLinkServiceConnectionState": {
|
|
"description": "Connection state of the private endpoint connection",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/PrivateLinkServiceConnectionState"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"PrivateLinkServiceConnectionState": {
|
|
"description": "Connection state of the private endpoint connection",
|
|
"properties": {
|
|
"actionsRequired": {
|
|
"description": "A message indicating if changes on the service provider require any updates on the consumer.",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"description": "The reason for approval/rejection of the connection.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.",
|
|
"oneOf": [
|
|
{
|
|
"enum": [
|
|
"Pending",
|
|
"Approved",
|
|
"Rejected",
|
|
"Disconnected"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ResourceLogCategory": {
|
|
"description": "Resource log category configuration of a Microsoft.SignalRService resource.",
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Indicates whether or the resource log category is enabled.\r\nAvailable values: true, false.\r\nCase insensitive.",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Gets or sets the resource log category's name.\r\nAvailable values: ConnectivityLogs, MessagingLogs.\r\nCase insensitive.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ResourceLogConfiguration": {
|
|
"description": "Resource log configuration of a Microsoft.SignalRService resource.",
|
|
"properties": {
|
|
"categories": {
|
|
"description": "Gets or sets the list of category configurations.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/definitions/ResourceLogCategory"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ResourceReference": {
|
|
"description": "Reference to a resource.",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Resource ID.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ResourceSku": {
|
|
"description": "The billing information of the resource.",
|
|
"properties": {
|
|
"capacity": {
|
|
"description": "Optional, integer. The unit count of the resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n Free: 1;\r\n Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;\r\n Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;",
|
|
"oneOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1, Premium_P1",
|
|
"type": "string"
|
|
},
|
|
"tier": {
|
|
"description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.",
|
|
"oneOf": [
|
|
{
|
|
"enum": [
|
|
"Free",
|
|
"Basic",
|
|
"Standard",
|
|
"Premium"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"ServerlessSettings": {
|
|
"description": "Serverless settings.",
|
|
"properties": {
|
|
"connectionTimeoutInSeconds": {
|
|
"description": "Gets or sets Client Connection Timeout. Optional to be set.\r\nValue in seconds.\r\nDefault value is 30 seconds.\r\nCustomer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals,\r\nand want the client to disconnect more quickly after the last message is sent.\r\nYou can set the timeout to a longer period if messages are expected to be sent in longer intervals,\r\nand they want to keep the same client connection alive during this session.\r\nThe service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval.",
|
|
"oneOf": [
|
|
{
|
|
"default": 30,
|
|
"maximum": 120,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ServerlessUpstreamSettings": {
|
|
"description": "The settings for the Upstream when the service is in server-less mode.",
|
|
"properties": {
|
|
"templates": {
|
|
"description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/definitions/UpstreamTemplate"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"SharedPrivateLinkResourceProperties": {
|
|
"description": "Describes the properties of an existing Shared Private Link Resource",
|
|
"properties": {
|
|
"groupId": {
|
|
"description": "The group id from the provider of resource the shared private link resource is for",
|
|
"type": "string"
|
|
},
|
|
"privateLinkResourceId": {
|
|
"description": "The resource id of the resource the shared private link resource is for",
|
|
"type": "string"
|
|
},
|
|
"requestMessage": {
|
|
"description": "The request message for requesting approval of the shared private link resource",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"groupId",
|
|
"privateLinkResourceId"
|
|
],
|
|
"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.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"SignalRFeature": {
|
|
"description": "Feature of a resource, which controls the 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.\r\n- EnableMessagingLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.\r\n- EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: \"true\"/\"false\", to enable/disable live trace feature.",
|
|
"oneOf": [
|
|
{
|
|
"enum": [
|
|
"ServiceMode",
|
|
"EnableConnectivityLogs",
|
|
"EnableMessagingLogs",
|
|
"EnableLiveTrace"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"properties": {
|
|
"description": "Optional properties related to this feature.",
|
|
"oneOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"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"
|
|
},
|
|
"SignalRNetworkACLs": {
|
|
"description": "Network ACLs for the resource",
|
|
"properties": {
|
|
"defaultAction": {
|
|
"description": "Azure Networking ACL Action.",
|
|
"oneOf": [
|
|
{
|
|
"enum": [
|
|
"Allow",
|
|
"Deny"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"privateEndpoints": {
|
|
"description": "ACLs for requests from private endpoints",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/definitions/PrivateEndpointACL"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"publicNetwork": {
|
|
"description": "Network ACL",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/NetworkACL"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"SignalRProperties": {
|
|
"description": "A class that describes the properties of the resource",
|
|
"properties": {
|
|
"cors": {
|
|
"description": "Cross-Origin Resource Sharing (CORS) settings.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/SignalRCorsSettings"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"disableAadAuth": {
|
|
"description": "DisableLocalAuth\r\nEnable or disable aad auth\r\nWhen set as true, connection with AuthType=aad won't work.",
|
|
"oneOf": [
|
|
{
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"disableLocalAuth": {
|
|
"description": "DisableLocalAuth\r\nEnable or disable local auth with AccessKey\r\nWhen set as true, connection with AccessKey=xxx won't work.",
|
|
"oneOf": [
|
|
{
|
|
"default": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"features": {
|
|
"description": "List of the featureFlags.\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, its globally default value will be used\r\nBut keep in mind, the default value doesn't mean \"false\". It varies in terms of different FeatureFlags.",
|
|
"oneOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/definitions/SignalRFeature"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"liveTraceConfiguration": {
|
|
"description": "Live trace configuration of a Microsoft.SignalRService resource.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/LiveTraceConfiguration"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"networkACLs": {
|
|
"description": "Network ACLs for the resource",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/SignalRNetworkACLs"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"publicNetworkAccess": {
|
|
"default": "Enabled",
|
|
"description": "Enable or disable public network access. Default to \"Enabled\".\r\nWhen it's Enabled, network ACLs still apply.\r\nWhen it's Disabled, public network access is always disabled no matter what you set in network ACLs.",
|
|
"type": "string"
|
|
},
|
|
"resourceLogConfiguration": {
|
|
"description": "Resource log configuration of a Microsoft.SignalRService resource.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/ResourceLogConfiguration"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"serverless": {
|
|
"description": "Serverless settings.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/ServerlessSettings"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"tls": {
|
|
"description": "TLS settings for the resource",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/SignalRTlsSettings"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"upstream": {
|
|
"description": "The settings for the Upstream when the service is in server-less mode.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/ServerlessUpstreamSettings"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"SignalRTlsSettings": {
|
|
"description": "TLS settings for the resource",
|
|
"properties": {
|
|
"clientCertEnabled": {
|
|
"description": "Request client certificate during TLS handshake if enabled",
|
|
"oneOf": [
|
|
{
|
|
"default": true,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"UpstreamAuthSettings": {
|
|
"description": "Upstream auth settings. If not set, no auth is used for upstream messages.",
|
|
"properties": {
|
|
"managedIdentity": {
|
|
"description": "Managed identity settings for upstream.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/ManagedIdentitySettings"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "Upstream auth type enum.",
|
|
"oneOf": [
|
|
{
|
|
"enum": [
|
|
"None",
|
|
"ManagedIdentity"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"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.",
|
|
"properties": {
|
|
"auth": {
|
|
"description": "Upstream auth settings. If not set, no auth is used for upstream messages.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/UpstreamAuthSettings"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"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"
|
|
},
|
|
"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"
|
|
},
|
|
"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"
|
|
},
|
|
"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"
|
|
}
|
|
},
|
|
"required": [
|
|
"urlTemplate"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"UserAssignedIdentityProperty": {
|
|
"description": "Properties of user assigned identity.",
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
"signalR_customCertificates_childResource": {
|
|
"description": "Microsoft.SignalRService/signalR/customCertificates",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Custom certificate name",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "Custom certificate properties.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/CustomCertificateProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"customCertificates"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"signalR_customDomains_childResource": {
|
|
"description": "Microsoft.SignalRService/signalR/customDomains",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "Custom domain name.",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "Properties of a custom domain.",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/CustomDomainProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"customDomains"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"signalR_privateEndpointConnections_childResource": {
|
|
"description": "Microsoft.SignalRService/signalR/privateEndpointConnections",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the private endpoint connection",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "Private endpoint connection properties",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/PrivateEndpointConnectionProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"privateEndpointConnections"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"signalR_sharedPrivateLinkResources_childResource": {
|
|
"description": "Microsoft.SignalRService/signalR/sharedPrivateLinkResources",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"enum": [
|
|
"2023-02-01"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name of the shared private link resource",
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"description": "Describes the properties of an existing Shared Private Link Resource",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/definitions/SharedPrivateLinkResourceProperties"
|
|
},
|
|
{
|
|
"$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"sharedPrivateLinkResources"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"properties",
|
|
"apiVersion",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
} |