Azure SignalR Service data plane REST API - v1

Este artículo contiene las APIs REST versión v1 para Azure SignalR Service Data Plane.

API disponibles

API Path
Difunde un mensaje a todos los clientes conectados al hub objetivo. POST /api/v1/hubs/{hub}
Difunde un mensaje a todos los clientes que pertenecen al usuario objetivo. POST /api/v1/hubs/{hub}/users/{id}
Envía mensaje a la conexión específica. POST /api/v1/hubs/{hub}/connections/{connectionId}
Comprueba si existe la conexión con el ID de conexión dado GET /api/v1/hubs/{hub}/connections/{connectionId}
Cerrar la conexión del cliente DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Difunde un mensaje a todos los clientes dentro del grupo objetivo. POST /api/v1/hubs/{hub}/groups/{group}
Comprueba si hay conexiones con clientes dentro del grupo dado GET /api/v1/hubs/{hub}/groups/{group}
Comprueba si hay conexiones de cliente conectadas para ese usuario GET /api/v1/hubs/{hub}/users/{user}
Añade una conexión al grupo objetivo. PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Elimina una conexión del grupo objetivo. DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Comprueba si existe un usuario en el grupo objetivo. GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Añade un usuario al grupo objetivo. PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Elimina a un usuario del grupo objetivo. DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Elimina a un usuario de todos los grupos. DELETE /api/v1/hubs/{hub}/users/{user}/groups

Difunde un mensaje a todos los clientes conectados al hub objetivo.

POST /api/v1/hubs/{hub}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
excluido query IDs de conexión excluidos No [ cuerda ]
Responses
Code Description
202 Success
400 Solicitud incorrecta

Difunde un mensaje a todos los clientes que pertenecen al usuario objetivo.

POST /api/v1/hubs/{hub}/users/{id}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
id ruta Identificador de usuario. Sí string
Responses
Code Description
202 Success
400 Solicitud incorrecta

Envía mensaje a la conexión específica.

POST /api/v1/hubs/{hub}/connections/{connectionId}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
connectionId ruta Identificador de conexión. Sí string
Responses
Code Description
202 Success
400 Solicitud incorrecta

Comprueba si existe la conexión con el ID de conexión dado

GET /api/v1/hubs/{hub}/connections/{connectionId}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Sí string
connectionId ruta Sí string
Responses
Code Description
200 Success
400 Solicitud incorrecta
404 No encontrado

Cerrar la conexión del cliente

DELETE /api/v1/hubs/{hub}/connections/{connectionId}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Sí string
connectionId ruta Sí string
reason query No string
Responses
Code Description
202 Success
400 Solicitud incorrecta

Difunde un mensaje a todos los clientes dentro del grupo objetivo.

POST /api/v1/hubs/{hub}/groups/{group}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
group ruta Nombre del grupo objetivo, cuya longitud debe ser mayor que 0 y menor que 1025. Sí string
excluido query IDs de conexión excluidos No [ cuerda ]
Responses
Code Description
202 Success
400 Solicitud incorrecta

Compruebe si hay conexiones de cliente dentro del grupo especificado

GET /api/v1/hubs/{hub}/groups/{group}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Sí string
group ruta Sí string
Responses
Code Description
200 Success
400 Solicitud incorrecta
404 No encontrado

Comprueba si hay conexiones de cliente conectadas para ese usuario

GET /api/v1/hubs/{hub}/users/{user}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Sí string
user ruta Sí string
Responses
Code Description
200 Success
400 Solicitud incorrecta
404 No encontrado

Agregue una conexión al grupo de destino.

PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
group ruta Nombre del grupo objetivo, cuya longitud debe ser mayor que 0 y menor que 1025. Sí string
connectionId ruta ID de conexión de destino Sí string
Responses
Code Description
200 Success
400 Solicitud incorrecta
404 No encontrado

Elimine una conexión del grupo de destino.

DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
group ruta Nombre del grupo objetivo, cuya longitud debe ser mayor que 0 y menor que 1025. Sí string
connectionId ruta ID de conexión de destino Sí string
Responses
Code Description
200 Success
400 Solicitud incorrecta
404 No encontrado

Comprueba si existe un usuario en el grupo objetivo.

GET /api/v1/hubs/{hub}/groups/{group}/users/{user}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
group ruta Nombre del grupo objetivo, cuya longitud debe ser mayor que 0 y menor que 1025. Sí string
user ruta ID de usuario objetivo Sí string
Responses
Code Description
200 Success
400 Solicitud incorrecta
404 No encontrado

Agregue un usuario al grupo de destino.

PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
group ruta Nombre del grupo objetivo, cuya longitud debe ser mayor que 0 y menor que 1025. Sí string
user ruta ID de usuario objetivo Sí string
ttl query Especifica los segundos en los que el usuario existe en el grupo. Si no está fija, el usuario vive en el grupo como máximo 1 año. Ten en cuenta que cuando TTL no está activado, el servicio conserva 100 relaciones entre grupos de usuario y las antiguas relaciones de grupo de usuarios se sobrescriben por otras nuevas añadidas. No integer
Responses
Code Description
202 Success
400 Solicitud incorrecta

Eliminar un usuario del grupo objetivo.

DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
group ruta Nombre del grupo objetivo, cuya longitud debe ser mayor que 0 y menor que 1025. Sí string
user ruta ID de usuario objetivo Sí string
Responses
Code Description
202 Success
400 Solicitud incorrecta

Eliminar un usuario de todos los grupos.

DELETE /api/v1/hubs/{hub}/users/{user}/groups

Parameters
Nombre Ubicado en Description Obligatorio Schema
centro ruta Nombre del núcleo objetivo, que debe comenzar con caracteres alfabéticos y contener solo caracteres alfanuméricos o guion subjugado. Sí string
user ruta ID de usuario objetivo Sí string
Responses
Code Description
200 El usuario es eliminado
202 La solicitud de eliminación es aceptada y el servicio la gestiona en segundo plano
400 Solicitud incorrecta

Models

PayloadMessage

Nombre Tipo Description Obligatorio
Objetivo string No
Arguments [ objeto ] No
  • Last updated on