Web Pub Sub - Close Connection
Zamknij połączenie klienta.
DELETE {endpoint}/api/hubs/{hub}/connections/{connectionId}?api-version=2024-01-01
DELETE {endpoint}/api/hubs/{hub}/connections/{connectionId}?reason={reason}&api-version=2024-01-01
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
connection
|
path | True |
string minLength: 1 |
Identyfikator połączenia docelowego. |
|
endpoint
|
path | True |
string (url) |
Punkt końcowy HTTP lub HTTPS dla wystąpienia usługi Web PubSub. |
|
hub
|
path | True |
string pattern: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$ |
Nazwa centrum docelowego, która powinna zaczynać się od znaków alfabetycznych i zawierać tylko znaki alfanumeryczne lub podkreślenie. |
|
api-version
|
query | True |
string |
Wersja interfejsów API REST. |
|
reason
|
query |
string |
Przyczyna zamknięcia połączenia klienta. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 204 No Content |
Brak zawartości |
|
| Other Status Codes |
Odpowiedź na błąd Nagłówki x-ms-error-code: string |
Przykłady
WebPubSub_CloseConnection
Przykładowe żądanie
DELETE {endpoint}/api/hubs/hub1/connections/connection1?reason=Close reason&api-version=2024-01-01
Przykładowa odpowiedź
Definicje
| Nazwa | Opis |
|---|---|
|
Error |
Obiekt błędu. |
|
Inner |
ErrorDetail
Obiekt błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
| details |
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu. |
|
| inner | ||
| message |
string |
Czytelna dla człowieka reprezentacja błędu. |
| target |
string |
Element docelowy błędu. |
InnerError
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający. |
| inner |