Aracılığıyla paylaş


veri düzlemi REST API'sini Azure SignalR Hizmeti - v1

Bu makale, Azure SignalR Hizmeti veri düzlemi için v1 sürümü REST API'lerini içerir.

Kullanılabilir API’ler

API Yol
Hedef hub'a bağlı tüm istemcilere bir ileti yayınlayın. POST /api/v1/hubs/{hub}
Tüm istemcilere ileti yayınlamak hedef kullanıcıya aittir. POST /api/v1/hubs/{hub}/users/{id}
belirli bir bağlantıya ileti gönderin. POST /api/v1/hubs/{hub}/connections/{connectionId}
Verilen connectionId ile bağlantının mevcut olup olmadığını denetleyin GET /api/v1/hubs/{hub}/connections/{connectionId}
İstemci bağlantısını kapatma DELETE /api/v1/hubs/{hub}/connections/{connectionId}
Hedef gruptaki tüm istemcilere bir ileti yayınlayın. POST /api/v1/hubs/{hub}/groups/{group}
Verilen grubun içinde istemci bağlantısı olup olmadığını denetleyin GET /api/v1/hubs/{hub}/groups/{group}
Belirli bir kullanıcı için bağlı istemci bağlantısı olup olmadığını denetleyin GET /api/v1/hubs/{hub}/users/{user}
Hedef gruba bir bağlantı ekleyin. PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Hedef gruptan bir bağlantıyı kaldırın. DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}
Bir kullanıcının hedef grupta var olup olmadığını denetleyin. GET /api/v1/hubs/{hub}/groups/{group}/users/{user}
Hedef gruba bir kullanıcı ekleyin. PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}
Hedef gruptan bir kullanıcıyı kaldırın. DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}
Bir kullanıcıyı tüm gruplardan kaldırın. DELETE /api/v1/hubs/{hub}/users/{user}/groups

Hedef hub'a bağlı tüm istemcilere bir ileti yayınlayın.

POST /api/v1/hubs/{hub}

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
Dış -lanan query Dışlanan bağlantı kimlikleri Hayır [ dize ]
Yanıtlar
Kod Tanım
202 Başarılı
400 Hatalı İstek

Tüm istemcilere ileti yayınlamak hedef kullanıcıya aittir.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
kimlik yol Kullanıcı kimliği. Evet Dize
Yanıtlar
Kod Tanım
202 Başarılı
400 Hatalı İstek

belirli bir bağlantıya ileti gönderin.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
connectionId yol Bağlantı kimliği. Evet Dize
Yanıtlar
Kod Tanım
202 Başarılı
400 Hatalı İstek

Verilen connectionId ile bağlantının mevcut olup olmadığını denetleyin

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Evet Dize
connectionId yol Evet Dize
Yanıtlar
Kod Tanım
200 Başarılı
400 Hatalı İstek
404 Bulunamadı

İstemci bağlantısını kapatma

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Evet Dize
connectionId yol Evet Dize
reason query Hayır Dize
Yanıtlar
Kod Tanım
202 Başarılı
400 Hatalı İstek

Hedef gruptaki tüm istemcilere bir ileti yayınlayın.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
group yol Uzunluğu 0'dan büyük ve 1025'ten küçük olması gereken hedef grup adı. Evet Dize
Dış -lanan query Dışlanan bağlantı kimlikleri Hayır [ dize ]
Yanıtlar
Kod Tanım
202 Başarılı
400 Hatalı İstek

Verilen grubun içinde istemci bağlantısı olup olmadığını denetleyin

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Evet Dize
group yol Evet Dize
Yanıtlar
Kod Tanım
200 Başarılı
400 Hatalı İstek
404 Bulunamadı

Belirli bir kullanıcı için bağlı istemci bağlantısı olup olmadığını denetleyin

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Evet Dize
kullanıcı yol Evet Dize
Yanıtlar
Kod Tanım
200 Başarılı
400 Hatalı İstek
404 Bulunamadı

Hedef gruba bir bağlantı ekleyin.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
group yol Uzunluğu 0'dan büyük ve 1025'ten küçük olması gereken hedef grup adı. Evet Dize
connectionId yol Hedef bağlantı kimliği Evet Dize
Yanıtlar
Kod Tanım
200 Başarılı
400 Hatalı İstek
404 Bulunamadı

Hedef gruptan bir bağlantıyı kaldırın.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
group yol Uzunluğu 0'dan büyük ve 1025'ten küçük olması gereken hedef grup adı. Evet Dize
connectionId yol Hedef bağlantı kimliği Evet Dize
Yanıtlar
Kod Tanım
200 Başarılı
400 Hatalı İstek
404 Bulunamadı

Bir kullanıcının hedef grupta var olup olmadığını denetleyin.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
group yol Uzunluğu 0'dan büyük ve 1025'ten küçük olması gereken hedef grup adı. Evet Dize
kullanıcı yol Hedef kullanıcı kimliği Evet Dize
Yanıtlar
Kod Tanım
200 Başarılı
400 Hatalı İstek
404 Bulunamadı

Hedef gruba bir kullanıcı ekleyin.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
group yol Uzunluğu 0'dan büyük ve 1025'ten küçük olması gereken hedef grup adı. Evet Dize
kullanıcı yol Hedef kullanıcı kimliği Evet Dize
ttl query Kullanıcının grupta var olduğu saniyeleri belirtir. Ayarlanmadıysa, kullanıcı en fazla 1 yıl grupta yaşar. Ttl ayarlanmadığında hizmetin kullanıcı başına 100 kullanıcı grubu ilişkisini koruduğuna ve yeni eklenenler tarafından eski kullanıcı grubu ilişkisinin üzerine yazıldığını unutmayın. Hayır integer
Yanıtlar
Kod Tanım
202 Başarılı
400 Hatalı İstek

Hedef gruptan bir kullanıcıyı kaldırın.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
group yol Uzunluğu 0'dan büyük ve 1025'ten küçük olması gereken hedef grup adı. Evet Dize
kullanıcı yol Hedef kullanıcı kimliği Evet Dize
Yanıtlar
Kod Tanım
202 Başarılı
400 Hatalı İstek

Bir kullanıcıyı tüm gruplardan kaldırın.

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

Parametreler
Ad Bulunduğu yer: Tanım Gerekli Şema
Hub yol Hedef hub adı; alfabetik karakterlerle başlamalıdır ve yalnızca alfasayısal karakterler veya alt çizgi içerir. Evet Dize
kullanıcı yol Hedef kullanıcı kimliği Evet Dize
Yanıtlar
Kod Tanım
200 Kullanıcı silindi
202 Silme isteği kabul edilir ve hizmet isteği arka planda işler
400 Hatalı İstek

Modeller

PayloadMessage

Ad Tür Açıklama Gerekli
Hedef Dize Hayır
Bağımsız değişkenler [ object ] Hayır