Поделиться через


Microsoft.SignalRService signalR 2018-10-01

Определение ресурсов Bicep

Тип ресурса SignalR можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.SignalRService/signalR, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.SignalRService/signalR@2018-10-01' = {
  location: 'string'
  name: 'string'
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    features: [
      {
        flag: 'string'
        properties: {
          {customized property}: 'string'
        }
        value: 'string'
      }
    ]
    hostNamePrefix: 'string'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Значения свойств

Microsoft.SignalRService/signalR

Имя Описание Ценность
местоположение Регион Azure GEO: например, западная часть США Восточная часть США Северная часть США Южная часть США Западная Европа Северная Европа Восточная Азия Юго-Восточная Азия и так далее.
Георегион ресурса никогда не изменяется после его создания.
строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Параметры, используемые для подготовки или настройки ресурса SignalRCreateOrUpdatePropertiesOrSignalRProperties
SKU Сведения о выставлении счетов ресурса. (например, базовый и стандартный) ResourceSku
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ResourceSku

Имя Описание Ценность
способность Необязательное целое число. Количество единиц ресурса SignalR. 1 по умолчанию.

При наличии разрешены следующие значения:
Бесплатный: 1
Стандартный: 1,2 5 10 20 50 100
int
семья Необязательная строка. Для дальнейшего использования. струна
имя Имя номера SKU. Обязательно.

Допустимые значения: Standard_S1, Free_F1
строка (обязательно)
размер Необязательная строка. Для дальнейшего использования. струна
ярус Необязательный уровень этого конкретного номера SKU. "Стандартный" или "Бесплатный".

Basic устарели, вместо этого используйте Standard.
"Базовый"
"Бесплатный"
"Премиум"
"Стандартный"

SignalRCorsSettings

Имя Описание Ценность
allowedOrigins Возвращает или задает список источников, которые должны быть разрешены для вызова между источниками (например, http://example.com:12345). Используйте "*", чтобы разрешить все. Если опущено, разрешить все по умолчанию. string[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Имя Описание Ценность
cors Параметры общего доступа к ресурсам (CORS) между источниками. SignalRCorsSettings
Функции Список функций SignalRFlags. Например, ServiceMode.

ФункцииFlags, которые не включены в параметры операции обновления, не будут изменены.
И ответ будет включать только функцииFlags, которые явно заданы.
Если функцияFlag не задана явно, служба SignalR будет использовать глобальное значение по умолчанию.
Но помните, что значение по умолчанию не означает false. Он зависит от различных функцийFlags.
SignalRFeature[]
hostNamePrefix Префикс для имени узла службы SignalR. Сохранено для дальнейшего использования.
Имя узла будет иметь формат: <hostNamePrefix>.service.signalr.net.
струна

SignalRFeature

Имя Описание Ценность
флаг FeatureFlags — это поддерживаемые функции службы Azure SignalR.
— ServiceMode: флаг для серверного сервера для службы SignalR. Допустимые значения: "Default": у вас есть собственный внутренний сервер; "Бессерверный": у приложения нет серверного сервера; "Классический": для обратной совместимости. Поддержка режима по умолчанию и бессерверному режиму, но не рекомендуется; "PredefinedOnly": для будущего использования.
— EnableConnectivityLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно.
EnableConnectivityLogs
ServiceMode (обязательно)
свойства Необязательные свойства, связанные с этой функцией. SignalRFeatureProperties
ценность Значение флага функции. Сведения о допустимых значениях см. в документе службы Azure SignalR /azure/azure-signalr/. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 128 (обязательно)

SignalRFeatureProperties

Имя Описание Ценность

SignalRUpdateParametersTags

Имя Описание Ценность

Примеры краткого руководства

Следующие примеры краткого руководства по развертыванию этого типа ресурса.

Bicep-файл Описание
Развертывание службы Azure SignalR Этот шаблон создает службу Azure SignalR с помощью шаблона.

Определение ресурса шаблона ARM

Тип ресурса SignalR можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.SignalRService/signalR, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.SignalRService/signalR",
  "apiVersion": "2018-10-01",
  "name": "string",
  "location": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "features": [
      {
        "flag": "string",
        "properties": {
          "{customized property}": "string"
        },
        "value": "string"
      }
    ],
    "hostNamePrefix": "string"
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Значения свойств

Microsoft.SignalRService/signalR

Имя Описание Ценность
apiVersion Версия API '2018-10-01'
местоположение Регион Azure GEO: например, западная часть США Восточная часть США Северная часть США Южная часть США Западная Европа Северная Европа Восточная Азия Юго-Восточная Азия и так далее.
Георегион ресурса никогда не изменяется после его создания.
строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Параметры, используемые для подготовки или настройки ресурса SignalRCreateOrUpdatePropertiesOrSignalRProperties
SKU Сведения о выставлении счетов ресурса. (например, базовый и стандартный) ResourceSku
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.SignalRService/signalR"

ResourceSku

Имя Описание Ценность
способность Необязательное целое число. Количество единиц ресурса SignalR. 1 по умолчанию.

При наличии разрешены следующие значения:
Бесплатный: 1
Стандартный: 1,2 5 10 20 50 100
int
семья Необязательная строка. Для дальнейшего использования. струна
имя Имя номера SKU. Обязательно.

Допустимые значения: Standard_S1, Free_F1
строка (обязательно)
размер Необязательная строка. Для дальнейшего использования. струна
ярус Необязательный уровень этого конкретного номера SKU. "Стандартный" или "Бесплатный".

Basic устарели, вместо этого используйте Standard.
"Базовый"
"Бесплатный"
"Премиум"
"Стандартный"

SignalRCorsSettings

Имя Описание Ценность
allowedOrigins Возвращает или задает список источников, которые должны быть разрешены для вызова между источниками (например, http://example.com:12345). Используйте "*", чтобы разрешить все. Если опущено, разрешить все по умолчанию. string[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Имя Описание Ценность
cors Параметры общего доступа к ресурсам (CORS) между источниками. SignalRCorsSettings
Функции Список функций SignalRFlags. Например, ServiceMode.

ФункцииFlags, которые не включены в параметры операции обновления, не будут изменены.
И ответ будет включать только функцииFlags, которые явно заданы.
Если функцияFlag не задана явно, служба SignalR будет использовать глобальное значение по умолчанию.
Но помните, что значение по умолчанию не означает false. Он зависит от различных функцийFlags.
SignalRFeature[]
hostNamePrefix Префикс для имени узла службы SignalR. Сохранено для дальнейшего использования.
Имя узла будет иметь формат: <hostNamePrefix>.service.signalr.net.
струна

SignalRFeature

Имя Описание Ценность
флаг FeatureFlags — это поддерживаемые функции службы Azure SignalR.
— ServiceMode: флаг для серверного сервера для службы SignalR. Допустимые значения: "Default": у вас есть собственный внутренний сервер; "Бессерверный": у приложения нет серверного сервера; "Классический": для обратной совместимости. Поддержка режима по умолчанию и бессерверному режиму, но не рекомендуется; "PredefinedOnly": для будущего использования.
— EnableConnectivityLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно.
EnableConnectivityLogs
ServiceMode (обязательно)
свойства Необязательные свойства, связанные с этой функцией. SignalRFeatureProperties
ценность Значение флага функции. Сведения о допустимых значениях см. в документе службы Azure SignalR /azure/azure-signalr/. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 128 (обязательно)

SignalRFeatureProperties

Имя Описание Ценность

SignalRUpdateParametersTags

Имя Описание Ценность

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Развертывание службы Azure SignalR

развертывание в Azure
Этот шаблон создает службу Azure SignalR с помощью шаблона.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса SignalR можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.SignalRService/signalR, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.SignalRService/signalR@2018-10-01"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      features = [
        {
          flag = "string"
          properties = {
            {customized property} = "string"
          }
          value = "string"
        }
      ]
      hostNamePrefix = "string"
    }
  })
}

Значения свойств

Microsoft.SignalRService/signalR

Имя Описание Ценность
местоположение Регион Azure GEO: например, западная часть США Восточная часть США Северная часть США Южная часть США Западная Европа Северная Европа Восточная Азия Юго-Восточная Азия и так далее.
Георегион ресурса никогда не изменяется после его создания.
строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Параметры, используемые для подготовки или настройки ресурса SignalRCreateOrUpdatePropertiesOrSignalRProperties
SKU Сведения о выставлении счетов ресурса. (например, базовый и стандартный) ResourceSku
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.SignalRService/signalR@2018-10-01"

ResourceSku

Имя Описание Ценность
способность Необязательное целое число. Количество единиц ресурса SignalR. 1 по умолчанию.

При наличии разрешены следующие значения:
Бесплатный: 1
Стандартный: 1,2 5 10 20 50 100
int
семья Необязательная строка. Для дальнейшего использования. струна
имя Имя номера SKU. Обязательно.

Допустимые значения: Standard_S1, Free_F1
строка (обязательно)
размер Необязательная строка. Для дальнейшего использования. струна
ярус Необязательный уровень этого конкретного номера SKU. "Стандартный" или "Бесплатный".

Basic устарели, вместо этого используйте Standard.
"Базовый"
"Бесплатный"
"Премиум"
"Стандартный"

SignalRCorsSettings

Имя Описание Ценность
allowedOrigins Возвращает или задает список источников, которые должны быть разрешены для вызова между источниками (например, http://example.com:12345). Используйте "*", чтобы разрешить все. Если опущено, разрешить все по умолчанию. string[]

SignalRCreateOrUpdatePropertiesOrSignalRProperties

Имя Описание Ценность
cors Параметры общего доступа к ресурсам (CORS) между источниками. SignalRCorsSettings
Функции Список функций SignalRFlags. Например, ServiceMode.

ФункцииFlags, которые не включены в параметры операции обновления, не будут изменены.
И ответ будет включать только функцииFlags, которые явно заданы.
Если функцияFlag не задана явно, служба SignalR будет использовать глобальное значение по умолчанию.
Но помните, что значение по умолчанию не означает false. Он зависит от различных функцийFlags.
SignalRFeature[]
hostNamePrefix Префикс для имени узла службы SignalR. Сохранено для дальнейшего использования.
Имя узла будет иметь формат: <hostNamePrefix>.service.signalr.net.
струна

SignalRFeature

Имя Описание Ценность
флаг FeatureFlags — это поддерживаемые функции службы Azure SignalR.
— ServiceMode: флаг для серверного сервера для службы SignalR. Допустимые значения: "Default": у вас есть собственный внутренний сервер; "Бессерверный": у приложения нет серверного сервера; "Классический": для обратной совместимости. Поддержка режима по умолчанию и бессерверному режиму, но не рекомендуется; "PredefinedOnly": для будущего использования.
— EnableConnectivityLogs: "true"/"false", чтобы включить или отключить категорию журнала подключения соответственно.
EnableConnectivityLogs
ServiceMode (обязательно)
свойства Необязательные свойства, связанные с этой функцией. SignalRFeatureProperties
ценность Значение флага функции. Сведения о допустимых значениях см. в документе службы Azure SignalR /azure/azure-signalr/. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 128 (обязательно)

SignalRFeatureProperties

Имя Описание Ценность

SignalRUpdateParametersTags

Имя Описание Ценность