Microsoft.SignalRService signalR 2023-08-01-preview
- последние
- 2024-10-01-preview
- 2024-08-01-preview
- 2024-04-01-preview
- 2024-03-01
- 2024-01-01-preview
- 2023-08-01-preview
- 2023-06-01-preview
- 2023-03-01-preview
- 2023-02-01
- 2022-08-01-preview
- 2022-02-01
- 2021-10-01
- 2021-09-01-preview
- 2021-06-01-preview
- 2021-04-01-preview
- 2020-07-01-preview
- 2020-05-01
- 2018-10-01
- 2018-03-01-preview
Определение ресурсов Bicep
Тип ресурса SignalR можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.SignalRService/signalR, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.SignalRService/signalR@2023-08-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
cors: {
allowedOrigins: [
'string'
]
}
disableAadAuth: bool
disableLocalAuth: bool
features: [
{
flag: 'string'
properties: {
{customized property}: 'string'
}
value: 'string'
}
]
liveTraceConfiguration: {
categories: [
{
enabled: 'string'
name: 'string'
}
]
enabled: 'string'
}
networkACLs: {
defaultAction: 'string'
ipRules: [
{
action: 'string'
value: 'string'
}
]
privateEndpoints: [
{
allow: [
'string'
]
deny: [
'string'
]
name: 'string'
}
]
publicNetwork: {
allow: [
'string'
]
deny: [
'string'
]
}
}
publicNetworkAccess: 'string'
regionEndpointEnabled: 'string'
resourceLogConfiguration: {
categories: [
{
enabled: 'string'
name: 'string'
}
]
}
resourceStopped: 'string'
serverless: {
connectionTimeoutInSeconds: int
}
tls: {
clientCertEnabled: bool
}
upstream: {
templates: [
{
auth: {
managedIdentity: {
resource: 'string'
}
type: 'string'
}
categoryPattern: 'string'
eventPattern: 'string'
hubPattern: 'string'
urlTemplate: 'string'
}
]
}
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
IPRule
| Имя | Описание | Ценность |
|---|---|---|
| действие | Действие ACL сети Azure. | "Разрешить" "Запретить" |
| ценность | IP-адрес или CIDR или ServiceTag | струна |
LiveTraceCategory
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Указывает, включена ли категория динамической трассировки. Доступные значения: true, false. Без учета регистра. |
струна |
| имя | Возвращает или задает имя категории динамической трассировки. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра. |
струна |
LiveTraceConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| Категории | Возвращает или задает список конфигураций категорий. | LiveTraceCategory[] |
| Включен | Указывает, включена ли динамическая трассировка. Если задано значение true, клиент динамической трассировки может подключиться к службе. В противном случае клиент динамической трассировки не может подключиться к службе, чтобы получить любой журнал независимо от того, что вы настраиваете в категориях. Доступные значения: true, false. Без учета регистра. |
струна |
ManagedIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Представляет тип удостоверения: systemAssigned, userAssigned, None | "Нет" SystemAssigned UserAssigned |
| userAssignedIdentities | Получение или установка назначенных пользователем удостоверений | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| Имя | Описание | Ценность |
|---|---|---|
| ресурс | Ресурс, указывающий URI идентификатора приложения целевого ресурса. Он также отображается в утверждении aud (аудитории) выданного маркера. |
струна |
ManagedIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
Microsoft.SignalRService/signalR
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Класс представляет управляемые удостоверения, используемые для запроса и ответа | ManagedIdentity |
| добрый | Тип службы | "RawWebSockets" SignalR |
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 63 Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (обязательно) |
| свойства | Класс, описывающий свойства ресурса | SignalRProperties |
| SKU | Сведения о выставлении счетов ресурса. | ResourceSku |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
NetworkACL
| Имя | Описание | Ценность |
|---|---|---|
| разрешать | Разрешенные типы запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| отрицать | Типы отклоненных запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
PrivateEndpointACL
| Имя | Описание | Ценность |
|---|---|---|
| разрешать | Разрешенные типы запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| отрицать | Типы отклоненных запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| имя | Имя подключения частной конечной точки | строка (обязательно) |
ResourceLogCategory
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Указывает, включена ли категория журнала ресурсов. Доступные значения: true, false. Без учета регистра. |
струна |
| имя | Возвращает или задает имя категории журнала ресурсов. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра. |
струна |
ResourceLogConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| Категории | Возвращает или задает список конфигураций категорий. | ResourceLogCategory[] |
ResourceSku
| Имя | Описание | Ценность |
|---|---|---|
| способность | Необязательное целое число. Количество единиц ресурса. 1 по умолчанию. При наличии разрешены следующие значения: Бесплатный: 1; Стандарт: 1,2,3 4,5,6,7,8,9 10 20 30 40 50 60 70 80 90 100; Премиум: 1,2,3,4,5,6,7,8,9 10 20 30 40 50 60 70 80 90 100; |
int |
| имя | Имя номера SKU. Обязательно. Допустимые значения: Standard_S1, Free_F1, Premium_P1 |
строка (обязательно) |
| ярус | Необязательный уровень этого конкретного номера SKU. "Стандартный" или "Бесплатный". Basic устарели, вместо этого используйте Standard. |
"Базовый" "Бесплатный" "Премиум" "Стандартный" |
Бессерверные Наборы
| Имя | Описание | Ценность |
|---|---|---|
| connectionTimeoutInSeconds | Возвращает или задает время ожидания подключения клиента. Необязательный параметр для задания. Значение в секундах. Значение по умолчанию — 30 секунд. Клиент должен задать время ожидания на более короткий период, если сообщения, как ожидается, будут отправляться в более короткие интервалы, и хотите, чтобы клиент быстрее отключался после отправки последнего сообщения. Время ожидания можно задать на более длительный период, если ожидается, что сообщения будут отправляться в более длинные интервалы, и они хотят сохранить то же подключение клиента в течение этого сеанса. Служба считает, что клиент отключен, если он не получил сообщение (включая сохранение активности) в этом интервале. |
int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 120 |
ServerlessUpstreamSettings
| Имя | Описание | Ценность |
|---|---|---|
| Шаблоны | Возвращает или задает список шаблонов URL-адресов upstream. Порядок имеет значение, и первый соответствующий шаблон вступает в силу. | UpstreamTemplate[] |
SignalRCorsSettings
| Имя | Описание | Ценность |
|---|---|---|
| allowedOrigins | Возвращает или задает список источников, которые должны быть разрешены для вызова между источниками (например, http://example.com:12345). Используйте "*", чтобы разрешить все. Если опущено, разрешить все по умолчанию. | string[] |
SignalRFeature
| Имя | Описание | Ценность |
|---|---|---|
| флаг | FeatureFlags — это поддерживаемые функции службы Azure SignalR. — ServiceMode: флаг для серверного сервера для службы SignalR. Допустимые значения: "Default": у вас есть собственный внутренний сервер; "Бессерверный": у приложения нет серверного сервера; "Классический": для обратной совместимости. Поддержка режима по умолчанию и бессерверному режиму, но не рекомендуется; "PredefinedOnly": для будущего использования. — EnableConnectivityLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно. — EnableMessagingLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно. — EnableLiveTrace: Динамическая трассировка позволяет узнать, что происходит внутри службы Azure SignalR, она даст вам динамические трассировки в режиме реального времени, это будет полезно при разработке собственного веб-приложения Azure SignalR или самостоятельного устранения некоторых проблем. Обратите внимание, что динамические трассировки считаются исходящими сообщениями, которые будут взиматься. Допустимые значения: true/"false", чтобы включить или отключить функцию динамической трассировки. |
EnableConnectivityLogs EnableLiveTrace EnableMessagingLogs ServiceMode (обязательно) |
| свойства | Необязательные свойства, связанные с этой функцией. | SignalRFeatureProperties |
| ценность | Значение флага функции. Сведения о допустимых значениях см. в документе службы Azure SignalR /azure/azure-signalr/. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 128 (обязательно) |
SignalRFeatureProperties
| Имя | Описание | Ценность |
|---|
SignalRNetworkACLs
| Имя | Описание | Ценность |
|---|---|---|
| defaultAction | Действие ACL сети Azure. | "Разрешить" "Запретить" |
| ipRules | Правила IP-адресов для фильтрации общедоступного трафика | IPRule[] |
| privateEndpoints | Списки управления доступом для запросов из частных конечных точек | PrivateEndpointACL[] |
| publicNetwork | ACL сети | NetworkACL |
SignalRProperties
| Имя | Описание | Ценность |
|---|---|---|
| cors | Параметры общего доступа к ресурсам (CORS) между источниками. | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth Включение или отключение проверки подлинности aad Если задано значение true, подключение к AuthType=aad не будет работать. |
bool |
| disableLocalAuth | DisableLocalAuth Включение или отключение локальной проверки подлинности с помощью AccessKey Если задано значение true, подключение к AccessKey=xxx не будет работать. |
bool |
| Функции | Список функцийFlags. ФункцииFlags, которые не включены в параметры операции обновления, не будут изменены. И ответ будет включать только функцииFlags, которые явно заданы. Если функцияFlag не задана явным образом, будет использоваться его глобальное значение по умолчанию Но помните, что значение по умолчанию не означает false. Он зависит от различных функцийFlags. |
SignalRFeature[] |
| liveTraceConfiguration | Конфигурация динамической трассировки ресурса Microsoft.SignalRService. | LiveTraceConfiguration |
| networkACLs | Сетевые списки управления доступом для ресурса | SignalRNetworkACLs |
| publicNetworkAccess | Включение или отключение доступа к общедоступной сети. Значение по умолчанию — "Включено". Если он включен, сетевые списки управления доступом по-прежнему применяются. Если он отключен, доступ к общедоступной сети всегда отключен независимо от того, что вы устанавливаете в сетевых списках управления доступом. |
струна |
| regionEndpointEnabled | Включите или отключите региональную конечную точку. Значение по умолчанию — "Включено". При отключении новые подключения не будут перенаправлены в эту конечную точку, однако существующие подключения не будут затронуты. Это свойство зависит от реплики. Отключить региональную конечную точку без реплики запрещено. |
струна |
| resourceLogConfiguration | Конфигурация журнала ресурсов ресурса Microsoft.SignalRService. | ResourceLogConfiguration |
| resourceStopped | Остановите или запустите ресурс. По умолчанию — False. Если это верно, плоскость данных ресурса завершается. Когда это значение равно false, запускается плоскость данных ресурса. |
струна |
| Бессерверный | Бессерверные параметры. | Бессерверные Наборы |
| tls | Параметры TLS для ресурса | SignalRTlsSettings |
| вверх по течению | Параметры для вышестоящего сервера, если служба находится в режиме без сервера. | ServerlessUpstreamSettings |
SignalRTlsSettings
| Имя | Описание | Ценность |
|---|---|---|
| clientCertEnabled | Запрос сертификата клиента во время подтверждения TLS, если включен. Не поддерживается для бесплатного уровня. Любые входные данные будут игнорироваться для бесплатного уровня. | bool |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
UpstreamAuthSettings
| Имя | Описание | Ценность |
|---|---|---|
| managedIdentity | Параметры управляемого удостоверения для вышестоящего потока. | ManagedIdentitySettings |
| тип | Перечисление типа вышестоящей проверки подлинности. | ManagedIdentity "Нет" |
UpstreamTemplate
| Имя | Описание | Ценность |
|---|---|---|
| auth | Параметры вышестоящей проверки подлинности. Если не задано, для исходящих сообщений не используется проверка подлинности. | upstreamAuthSettings |
| categoryPattern | Возвращает или задает шаблон сопоставления для имен категорий. Если он не задан, он соответствует любой категории. Поддерживаются 3 типа шаблонов: 1. "*", он соответствует любому имени категории. 2. Объединение нескольких категорий с ",", например "подключения,сообщения", оно соответствует категории "подключения" и "сообщения". 3. Имя одной категории, например "connections", соответствует категории "подключения". |
струна |
| eventPattern | Возвращает или задает шаблон сопоставления для имен событий. Если он не задан, он соответствует любому событию. Поддерживаются 3 типа шаблонов: 1. "*", оно соответствует любому имени события. 2. Объединение нескольких событий с ",", например "подключение,отключение", оно соответствует событию "connect" и "отключить". 3. Имя одного события, например "connect", оно соответствует "connect". |
струна |
| hubPattern | Возвращает или задает шаблон сопоставления для имен концентраторов. Если он не задан, он соответствует любому концентратору. Поддерживаются 3 типа шаблонов: 1. "*", оно соответствует любому имени концентратора. 2. Объединение нескольких центров с ",", например "hub1,hub2", оно соответствует "hub1" и "hub2". 3. Имя одного концентратора, например hub1, соответствует "hub1". |
струна |
| urlTemplate | Возвращает или задает шаблон URL-адреса вышестоящего потока. В шаблоне можно использовать 3 предопределенных параметра {hub}, {category} {event} внутри шаблона, значение URL-адреса вышестоящего потока вычисляется динамически при появлении запроса клиента. Например, если urlTemplate http://example.com/{hub}/api/{event}, с запросом клиента из концентратора chat подключается, он будет сначала POST к этому URL-адресу: http://example.com/chat/api/connect. |
строка (обязательно) |
UserAssignedIdentityProperty
| Имя | Описание | Ценность |
|---|
Примеры краткого руководства
Следующие примеры краткого руководства по развертыванию этого типа ресурса.
| Bicep-файл | Описание |
|---|---|
| Развертывание службы Azure SignalR | Этот шаблон создает службу Azure SignalR с помощью шаблона. |
Определение ресурса шаблона ARM
Тип ресурса SignalR можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.SignalRService/signalR, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.SignalRService/signalR",
"apiVersion": "2023-08-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"cors": {
"allowedOrigins": [ "string" ]
},
"disableAadAuth": "bool",
"disableLocalAuth": "bool",
"features": [
{
"flag": "string",
"properties": {
"{customized property}": "string"
},
"value": "string"
}
],
"liveTraceConfiguration": {
"categories": [
{
"enabled": "string",
"name": "string"
}
],
"enabled": "string"
},
"networkACLs": {
"defaultAction": "string",
"ipRules": [
{
"action": "string",
"value": "string"
}
],
"privateEndpoints": [
{
"allow": [ "string" ],
"deny": [ "string" ],
"name": "string"
}
],
"publicNetwork": {
"allow": [ "string" ],
"deny": [ "string" ]
}
},
"publicNetworkAccess": "string",
"regionEndpointEnabled": "string",
"resourceLogConfiguration": {
"categories": [
{
"enabled": "string",
"name": "string"
}
]
},
"resourceStopped": "string",
"serverless": {
"connectionTimeoutInSeconds": "int"
},
"tls": {
"clientCertEnabled": "bool"
},
"upstream": {
"templates": [
{
"auth": {
"managedIdentity": {
"resource": "string"
},
"type": "string"
},
"categoryPattern": "string",
"eventPattern": "string",
"hubPattern": "string",
"urlTemplate": "string"
}
]
}
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
IPRule
| Имя | Описание | Ценность |
|---|---|---|
| действие | Действие ACL сети Azure. | "Разрешить" "Запретить" |
| ценность | IP-адрес или CIDR или ServiceTag | струна |
LiveTraceCategory
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Указывает, включена ли категория динамической трассировки. Доступные значения: true, false. Без учета регистра. |
струна |
| имя | Возвращает или задает имя категории динамической трассировки. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра. |
струна |
LiveTraceConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| Категории | Возвращает или задает список конфигураций категорий. | LiveTraceCategory[] |
| Включен | Указывает, включена ли динамическая трассировка. Если задано значение true, клиент динамической трассировки может подключиться к службе. В противном случае клиент динамической трассировки не может подключиться к службе, чтобы получить любой журнал независимо от того, что вы настраиваете в категориях. Доступные значения: true, false. Без учета регистра. |
струна |
ManagedIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Представляет тип удостоверения: systemAssigned, userAssigned, None | "Нет" SystemAssigned UserAssigned |
| userAssignedIdentities | Получение или установка назначенных пользователем удостоверений | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| Имя | Описание | Ценность |
|---|---|---|
| ресурс | Ресурс, указывающий URI идентификатора приложения целевого ресурса. Он также отображается в утверждении aud (аудитории) выданного маркера. |
струна |
ManagedIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
Microsoft.SignalRService/signalR
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2023-08-01-preview' |
| тождество | Класс представляет управляемые удостоверения, используемые для запроса и ответа | ManagedIdentity |
| добрый | Тип службы | "RawWebSockets" SignalR |
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 63 Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (обязательно) |
| свойства | Класс, описывающий свойства ресурса | SignalRProperties |
| SKU | Сведения о выставлении счетов ресурса. | ResourceSku |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.SignalRService/signalR" |
NetworkACL
| Имя | Описание | Ценность |
|---|---|---|
| разрешать | Разрешенные типы запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| отрицать | Типы отклоненных запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
PrivateEndpointACL
| Имя | Описание | Ценность |
|---|---|---|
| разрешать | Разрешенные типы запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| отрицать | Типы отклоненных запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| имя | Имя подключения частной конечной точки | строка (обязательно) |
ResourceLogCategory
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Указывает, включена ли категория журнала ресурсов. Доступные значения: true, false. Без учета регистра. |
струна |
| имя | Возвращает или задает имя категории журнала ресурсов. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра. |
струна |
ResourceLogConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| Категории | Возвращает или задает список конфигураций категорий. | ResourceLogCategory[] |
ResourceSku
| Имя | Описание | Ценность |
|---|---|---|
| способность | Необязательное целое число. Количество единиц ресурса. 1 по умолчанию. При наличии разрешены следующие значения: Бесплатный: 1; Стандарт: 1,2,3 4,5,6,7,8,9 10 20 30 40 50 60 70 80 90 100; Премиум: 1,2,3,4,5,6,7,8,9 10 20 30 40 50 60 70 80 90 100; |
int |
| имя | Имя номера SKU. Обязательно. Допустимые значения: Standard_S1, Free_F1, Premium_P1 |
строка (обязательно) |
| ярус | Необязательный уровень этого конкретного номера SKU. "Стандартный" или "Бесплатный". Basic устарели, вместо этого используйте Standard. |
"Базовый" "Бесплатный" "Премиум" "Стандартный" |
Бессерверные Наборы
| Имя | Описание | Ценность |
|---|---|---|
| connectionTimeoutInSeconds | Возвращает или задает время ожидания подключения клиента. Необязательный параметр для задания. Значение в секундах. Значение по умолчанию — 30 секунд. Клиент должен задать время ожидания на более короткий период, если сообщения, как ожидается, будут отправляться в более короткие интервалы, и хотите, чтобы клиент быстрее отключался после отправки последнего сообщения. Время ожидания можно задать на более длительный период, если ожидается, что сообщения будут отправляться в более длинные интервалы, и они хотят сохранить то же подключение клиента в течение этого сеанса. Служба считает, что клиент отключен, если он не получил сообщение (включая сохранение активности) в этом интервале. |
int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 120 |
ServerlessUpstreamSettings
| Имя | Описание | Ценность |
|---|---|---|
| Шаблоны | Возвращает или задает список шаблонов URL-адресов upstream. Порядок имеет значение, и первый соответствующий шаблон вступает в силу. | UpstreamTemplate[] |
SignalRCorsSettings
| Имя | Описание | Ценность |
|---|---|---|
| allowedOrigins | Возвращает или задает список источников, которые должны быть разрешены для вызова между источниками (например, http://example.com:12345). Используйте "*", чтобы разрешить все. Если опущено, разрешить все по умолчанию. | string[] |
SignalRFeature
| Имя | Описание | Ценность |
|---|---|---|
| флаг | FeatureFlags — это поддерживаемые функции службы Azure SignalR. — ServiceMode: флаг для серверного сервера для службы SignalR. Допустимые значения: "Default": у вас есть собственный внутренний сервер; "Бессерверный": у приложения нет серверного сервера; "Классический": для обратной совместимости. Поддержка режима по умолчанию и бессерверному режиму, но не рекомендуется; "PredefinedOnly": для будущего использования. — EnableConnectivityLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно. — EnableMessagingLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно. — EnableLiveTrace: Динамическая трассировка позволяет узнать, что происходит внутри службы Azure SignalR, она даст вам динамические трассировки в режиме реального времени, это будет полезно при разработке собственного веб-приложения Azure SignalR или самостоятельного устранения некоторых проблем. Обратите внимание, что динамические трассировки считаются исходящими сообщениями, которые будут взиматься. Допустимые значения: true/"false", чтобы включить или отключить функцию динамической трассировки. |
EnableConnectivityLogs EnableLiveTrace EnableMessagingLogs ServiceMode (обязательно) |
| свойства | Необязательные свойства, связанные с этой функцией. | SignalRFeatureProperties |
| ценность | Значение флага функции. Сведения о допустимых значениях см. в документе службы Azure SignalR /azure/azure-signalr/. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 128 (обязательно) |
SignalRFeatureProperties
| Имя | Описание | Ценность |
|---|
SignalRNetworkACLs
| Имя | Описание | Ценность |
|---|---|---|
| defaultAction | Действие ACL сети Azure. | "Разрешить" "Запретить" |
| ipRules | Правила IP-адресов для фильтрации общедоступного трафика | IPRule[] |
| privateEndpoints | Списки управления доступом для запросов из частных конечных точек | PrivateEndpointACL[] |
| publicNetwork | ACL сети | NetworkACL |
SignalRProperties
| Имя | Описание | Ценность |
|---|---|---|
| cors | Параметры общего доступа к ресурсам (CORS) между источниками. | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth Включение или отключение проверки подлинности aad Если задано значение true, подключение к AuthType=aad не будет работать. |
bool |
| disableLocalAuth | DisableLocalAuth Включение или отключение локальной проверки подлинности с помощью AccessKey Если задано значение true, подключение к AccessKey=xxx не будет работать. |
bool |
| Функции | Список функцийFlags. ФункцииFlags, которые не включены в параметры операции обновления, не будут изменены. И ответ будет включать только функцииFlags, которые явно заданы. Если функцияFlag не задана явным образом, будет использоваться его глобальное значение по умолчанию Но помните, что значение по умолчанию не означает false. Он зависит от различных функцийFlags. |
SignalRFeature[] |
| liveTraceConfiguration | Конфигурация динамической трассировки ресурса Microsoft.SignalRService. | LiveTraceConfiguration |
| networkACLs | Сетевые списки управления доступом для ресурса | SignalRNetworkACLs |
| publicNetworkAccess | Включение или отключение доступа к общедоступной сети. Значение по умолчанию — "Включено". Если он включен, сетевые списки управления доступом по-прежнему применяются. Если он отключен, доступ к общедоступной сети всегда отключен независимо от того, что вы устанавливаете в сетевых списках управления доступом. |
струна |
| regionEndpointEnabled | Включите или отключите региональную конечную точку. Значение по умолчанию — "Включено". При отключении новые подключения не будут перенаправлены в эту конечную точку, однако существующие подключения не будут затронуты. Это свойство зависит от реплики. Отключить региональную конечную точку без реплики запрещено. |
струна |
| resourceLogConfiguration | Конфигурация журнала ресурсов ресурса Microsoft.SignalRService. | ResourceLogConfiguration |
| resourceStopped | Остановите или запустите ресурс. По умолчанию — False. Если это верно, плоскость данных ресурса завершается. Когда это значение равно false, запускается плоскость данных ресурса. |
струна |
| Бессерверный | Бессерверные параметры. | Бессерверные Наборы |
| tls | Параметры TLS для ресурса | SignalRTlsSettings |
| вверх по течению | Параметры для вышестоящего сервера, если служба находится в режиме без сервера. | ServerlessUpstreamSettings |
SignalRTlsSettings
| Имя | Описание | Ценность |
|---|---|---|
| clientCertEnabled | Запрос сертификата клиента во время подтверждения TLS, если включен. Не поддерживается для бесплатного уровня. Любые входные данные будут игнорироваться для бесплатного уровня. | bool |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
UpstreamAuthSettings
| Имя | Описание | Ценность |
|---|---|---|
| managedIdentity | Параметры управляемого удостоверения для вышестоящего потока. | ManagedIdentitySettings |
| тип | Перечисление типа вышестоящей проверки подлинности. | ManagedIdentity "Нет" |
UpstreamTemplate
| Имя | Описание | Ценность |
|---|---|---|
| auth | Параметры вышестоящей проверки подлинности. Если не задано, для исходящих сообщений не используется проверка подлинности. | upstreamAuthSettings |
| categoryPattern | Возвращает или задает шаблон сопоставления для имен категорий. Если он не задан, он соответствует любой категории. Поддерживаются 3 типа шаблонов: 1. "*", он соответствует любому имени категории. 2. Объединение нескольких категорий с ",", например "подключения,сообщения", оно соответствует категории "подключения" и "сообщения". 3. Имя одной категории, например "connections", соответствует категории "подключения". |
струна |
| eventPattern | Возвращает или задает шаблон сопоставления для имен событий. Если он не задан, он соответствует любому событию. Поддерживаются 3 типа шаблонов: 1. "*", оно соответствует любому имени события. 2. Объединение нескольких событий с ",", например "подключение,отключение", оно соответствует событию "connect" и "отключить". 3. Имя одного события, например "connect", оно соответствует "connect". |
струна |
| hubPattern | Возвращает или задает шаблон сопоставления для имен концентраторов. Если он не задан, он соответствует любому концентратору. Поддерживаются 3 типа шаблонов: 1. "*", оно соответствует любому имени концентратора. 2. Объединение нескольких центров с ",", например "hub1,hub2", оно соответствует "hub1" и "hub2". 3. Имя одного концентратора, например hub1, соответствует "hub1". |
струна |
| urlTemplate | Возвращает или задает шаблон URL-адреса вышестоящего потока. В шаблоне можно использовать 3 предопределенных параметра {hub}, {category} {event} внутри шаблона, значение URL-адреса вышестоящего потока вычисляется динамически при появлении запроса клиента. Например, если urlTemplate http://example.com/{hub}/api/{event}, с запросом клиента из концентратора chat подключается, он будет сначала POST к этому URL-адресу: http://example.com/chat/api/connect. |
строка (обязательно) |
UserAssignedIdentityProperty
| Имя | Описание | Ценность |
|---|
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
Развертывание службы Azure SignalR развертывание  |
Этот шаблон создает службу Azure SignalR с помощью шаблона. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса SignalR можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.SignalRService/signalR, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.SignalRService/signalR@2023-08-01-preview"
name = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
cors = {
allowedOrigins = [
"string"
]
}
disableAadAuth = bool
disableLocalAuth = bool
features = [
{
flag = "string"
properties = {
{customized property} = "string"
}
value = "string"
}
]
liveTraceConfiguration = {
categories = [
{
enabled = "string"
name = "string"
}
]
enabled = "string"
}
networkACLs = {
defaultAction = "string"
ipRules = [
{
action = "string"
value = "string"
}
]
privateEndpoints = [
{
allow = [
"string"
]
deny = [
"string"
]
name = "string"
}
]
publicNetwork = {
allow = [
"string"
]
deny = [
"string"
]
}
}
publicNetworkAccess = "string"
regionEndpointEnabled = "string"
resourceLogConfiguration = {
categories = [
{
enabled = "string"
name = "string"
}
]
}
resourceStopped = "string"
serverless = {
connectionTimeoutInSeconds = int
}
tls = {
clientCertEnabled = bool
}
upstream = {
templates = [
{
auth = {
managedIdentity = {
resource = "string"
}
type = "string"
}
categoryPattern = "string"
eventPattern = "string"
hubPattern = "string"
urlTemplate = "string"
}
]
}
}
})
}
Значения свойств
IPRule
| Имя | Описание | Ценность |
|---|---|---|
| действие | Действие ACL сети Azure. | "Разрешить" "Запретить" |
| ценность | IP-адрес или CIDR или ServiceTag | струна |
LiveTraceCategory
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Указывает, включена ли категория динамической трассировки. Доступные значения: true, false. Без учета регистра. |
струна |
| имя | Возвращает или задает имя категории динамической трассировки. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра. |
струна |
LiveTraceConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| Категории | Возвращает или задает список конфигураций категорий. | LiveTraceCategory[] |
| Включен | Указывает, включена ли динамическая трассировка. Если задано значение true, клиент динамической трассировки может подключиться к службе. В противном случае клиент динамической трассировки не может подключиться к службе, чтобы получить любой журнал независимо от того, что вы настраиваете в категориях. Доступные значения: true, false. Без учета регистра. |
струна |
ManagedIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Представляет тип удостоверения: systemAssigned, userAssigned, None | "Нет" SystemAssigned UserAssigned |
| userAssignedIdentities | Получение или установка назначенных пользователем удостоверений | ManagedIdentityUserAssignedIdentities |
ManagedIdentitySettings
| Имя | Описание | Ценность |
|---|---|---|
| ресурс | Ресурс, указывающий URI идентификатора приложения целевого ресурса. Он также отображается в утверждении aud (аудитории) выданного маркера. |
струна |
ManagedIdentityUserAssignedIdentities
| Имя | Описание | Ценность |
|---|
Microsoft.SignalRService/signalR
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Класс представляет управляемые удостоверения, используемые для запроса и ответа | ManagedIdentity |
| добрый | Тип службы | "RawWebSockets" SignalR |
| местоположение | Географическое расположение, в котором находится ресурс | строка (обязательно) |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 63 Pattern = ^[a-zA-Z][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]$ (обязательно) |
| свойства | Класс, описывающий свойства ресурса | SignalRProperties |
| SKU | Сведения о выставлении счетов ресурса. | ResourceSku |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.SignalRService/signalR@2023-08-01-preview" |
NetworkACL
| Имя | Описание | Ценность |
|---|---|---|
| разрешать | Разрешенные типы запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| отрицать | Типы отклоненных запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
PrivateEndpointACL
| Имя | Описание | Ценность |
|---|---|---|
| разрешать | Разрешенные типы запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| отрицать | Типы отклоненных запросов. Значение может быть одним или несколькими: ClientConnection, ServerConnection, RESTAPI. | Массив строк, содержащий любой из: ClientConnection RESTAPI "ServerConnection" Trace |
| имя | Имя подключения частной конечной точки | строка (обязательно) |
ResourceLogCategory
| Имя | Описание | Ценность |
|---|---|---|
| Включен | Указывает, включена ли категория журнала ресурсов. Доступные значения: true, false. Без учета регистра. |
струна |
| имя | Возвращает или задает имя категории журнала ресурсов. Доступные значения: ConnectivityLogs, MessagingLogs. Без учета регистра. |
струна |
ResourceLogConfiguration
| Имя | Описание | Ценность |
|---|---|---|
| Категории | Возвращает или задает список конфигураций категорий. | ResourceLogCategory[] |
ResourceSku
| Имя | Описание | Ценность |
|---|---|---|
| способность | Необязательное целое число. Количество единиц ресурса. 1 по умолчанию. При наличии разрешены следующие значения: Бесплатный: 1; Стандарт: 1,2,3 4,5,6,7,8,9 10 20 30 40 50 60 70 80 90 100; Премиум: 1,2,3,4,5,6,7,8,9 10 20 30 40 50 60 70 80 90 100; |
int |
| имя | Имя номера SKU. Обязательно. Допустимые значения: Standard_S1, Free_F1, Premium_P1 |
строка (обязательно) |
| ярус | Необязательный уровень этого конкретного номера SKU. "Стандартный" или "Бесплатный". Basic устарели, вместо этого используйте Standard. |
"Базовый" "Бесплатный" "Премиум" "Стандартный" |
Бессерверные Наборы
| Имя | Описание | Ценность |
|---|---|---|
| connectionTimeoutInSeconds | Возвращает или задает время ожидания подключения клиента. Необязательный параметр для задания. Значение в секундах. Значение по умолчанию — 30 секунд. Клиент должен задать время ожидания на более короткий период, если сообщения, как ожидается, будут отправляться в более короткие интервалы, и хотите, чтобы клиент быстрее отключался после отправки последнего сообщения. Время ожидания можно задать на более длительный период, если ожидается, что сообщения будут отправляться в более длинные интервалы, и они хотят сохранить то же подключение клиента в течение этого сеанса. Служба считает, что клиент отключен, если он не получил сообщение (включая сохранение активности) в этом интервале. |
int Ограничения целостности: Минимальное значение = 1 Максимальное значение = 120 |
ServerlessUpstreamSettings
| Имя | Описание | Ценность |
|---|---|---|
| Шаблоны | Возвращает или задает список шаблонов URL-адресов upstream. Порядок имеет значение, и первый соответствующий шаблон вступает в силу. | UpstreamTemplate[] |
SignalRCorsSettings
| Имя | Описание | Ценность |
|---|---|---|
| allowedOrigins | Возвращает или задает список источников, которые должны быть разрешены для вызова между источниками (например, http://example.com:12345). Используйте "*", чтобы разрешить все. Если опущено, разрешить все по умолчанию. | string[] |
SignalRFeature
| Имя | Описание | Ценность |
|---|---|---|
| флаг | FeatureFlags — это поддерживаемые функции службы Azure SignalR. — ServiceMode: флаг для серверного сервера для службы SignalR. Допустимые значения: "Default": у вас есть собственный внутренний сервер; "Бессерверный": у приложения нет серверного сервера; "Классический": для обратной совместимости. Поддержка режима по умолчанию и бессерверному режиму, но не рекомендуется; "PredefinedOnly": для будущего использования. — EnableConnectivityLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно. — EnableMessagingLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно. — EnableLiveTrace: Динамическая трассировка позволяет узнать, что происходит внутри службы Azure SignalR, она даст вам динамические трассировки в режиме реального времени, это будет полезно при разработке собственного веб-приложения Azure SignalR или самостоятельного устранения некоторых проблем. Обратите внимание, что динамические трассировки считаются исходящими сообщениями, которые будут взиматься. Допустимые значения: true/"false", чтобы включить или отключить функцию динамической трассировки. |
EnableConnectivityLogs EnableLiveTrace EnableMessagingLogs ServiceMode (обязательно) |
| свойства | Необязательные свойства, связанные с этой функцией. | SignalRFeatureProperties |
| ценность | Значение флага функции. Сведения о допустимых значениях см. в документе службы Azure SignalR /azure/azure-signalr/. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 128 (обязательно) |
SignalRFeatureProperties
| Имя | Описание | Ценность |
|---|
SignalRNetworkACLs
| Имя | Описание | Ценность |
|---|---|---|
| defaultAction | Действие ACL сети Azure. | "Разрешить" "Запретить" |
| ipRules | Правила IP-адресов для фильтрации общедоступного трафика | IPRule[] |
| privateEndpoints | Списки управления доступом для запросов из частных конечных точек | PrivateEndpointACL[] |
| publicNetwork | ACL сети | NetworkACL |
SignalRProperties
| Имя | Описание | Ценность |
|---|---|---|
| cors | Параметры общего доступа к ресурсам (CORS) между источниками. | SignalRCorsSettings |
| disableAadAuth | DisableLocalAuth Включение или отключение проверки подлинности aad Если задано значение true, подключение к AuthType=aad не будет работать. |
bool |
| disableLocalAuth | DisableLocalAuth Включение или отключение локальной проверки подлинности с помощью AccessKey Если задано значение true, подключение к AccessKey=xxx не будет работать. |
bool |
| Функции | Список функцийFlags. ФункцииFlags, которые не включены в параметры операции обновления, не будут изменены. И ответ будет включать только функцииFlags, которые явно заданы. Если функцияFlag не задана явным образом, будет использоваться его глобальное значение по умолчанию Но помните, что значение по умолчанию не означает false. Он зависит от различных функцийFlags. |
SignalRFeature[] |
| liveTraceConfiguration | Конфигурация динамической трассировки ресурса Microsoft.SignalRService. | LiveTraceConfiguration |
| networkACLs | Сетевые списки управления доступом для ресурса | SignalRNetworkACLs |
| publicNetworkAccess | Включение или отключение доступа к общедоступной сети. Значение по умолчанию — "Включено". Если он включен, сетевые списки управления доступом по-прежнему применяются. Если он отключен, доступ к общедоступной сети всегда отключен независимо от того, что вы устанавливаете в сетевых списках управления доступом. |
струна |
| regionEndpointEnabled | Включите или отключите региональную конечную точку. Значение по умолчанию — "Включено". При отключении новые подключения не будут перенаправлены в эту конечную точку, однако существующие подключения не будут затронуты. Это свойство зависит от реплики. Отключить региональную конечную точку без реплики запрещено. |
струна |
| resourceLogConfiguration | Конфигурация журнала ресурсов ресурса Microsoft.SignalRService. | ResourceLogConfiguration |
| resourceStopped | Остановите или запустите ресурс. По умолчанию — False. Если это верно, плоскость данных ресурса завершается. Когда это значение равно false, запускается плоскость данных ресурса. |
струна |
| Бессерверный | Бессерверные параметры. | Бессерверные Наборы |
| tls | Параметры TLS для ресурса | SignalRTlsSettings |
| вверх по течению | Параметры для вышестоящего сервера, если служба находится в режиме без сервера. | ServerlessUpstreamSettings |
SignalRTlsSettings
| Имя | Описание | Ценность |
|---|---|---|
| clientCertEnabled | Запрос сертификата клиента во время подтверждения TLS, если включен. Не поддерживается для бесплатного уровня. Любые входные данные будут игнорироваться для бесплатного уровня. | bool |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
UpstreamAuthSettings
| Имя | Описание | Ценность |
|---|---|---|
| managedIdentity | Параметры управляемого удостоверения для вышестоящего потока. | ManagedIdentitySettings |
| тип | Перечисление типа вышестоящей проверки подлинности. | ManagedIdentity "Нет" |
UpstreamTemplate
| Имя | Описание | Ценность |
|---|---|---|
| auth | Параметры вышестоящей проверки подлинности. Если не задано, для исходящих сообщений не используется проверка подлинности. | upstreamAuthSettings |
| categoryPattern | Возвращает или задает шаблон сопоставления для имен категорий. Если он не задан, он соответствует любой категории. Поддерживаются 3 типа шаблонов: 1. "*", он соответствует любому имени категории. 2. Объединение нескольких категорий с ",", например "подключения,сообщения", оно соответствует категории "подключения" и "сообщения". 3. Имя одной категории, например "connections", соответствует категории "подключения". |
струна |
| eventPattern | Возвращает или задает шаблон сопоставления для имен событий. Если он не задан, он соответствует любому событию. Поддерживаются 3 типа шаблонов: 1. "*", оно соответствует любому имени события. 2. Объединение нескольких событий с ",", например "подключение,отключение", оно соответствует событию "connect" и "отключить". 3. Имя одного события, например "connect", оно соответствует "connect". |
струна |
| hubPattern | Возвращает или задает шаблон сопоставления для имен концентраторов. Если он не задан, он соответствует любому концентратору. Поддерживаются 3 типа шаблонов: 1. "*", оно соответствует любому имени концентратора. 2. Объединение нескольких центров с ",", например "hub1,hub2", оно соответствует "hub1" и "hub2". 3. Имя одного концентратора, например hub1, соответствует "hub1". |
струна |
| urlTemplate | Возвращает или задает шаблон URL-адреса вышестоящего потока. В шаблоне можно использовать 3 предопределенных параметра {hub}, {category} {event} внутри шаблона, значение URL-адреса вышестоящего потока вычисляется динамически при появлении запроса клиента. Например, если urlTemplate http://example.com/{hub}/api/{event}, с запросом клиента из концентратора chat подключается, он будет сначала POST к этому URL-адресу: http://example.com/chat/api/connect. |
строка (обязательно) |
UserAssignedIdentityProperty
| Имя | Описание | Ценность |
|---|