Udostępnij przez

az webpubsub hub

Note

Ta dokumentacja jest częścią rozszerzenia webpubsub dla interfejsu wiersza polecenia platformy Azure (wersja 2.56.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az webpubsub hub. Dowiedz się więcej o rozszerzeniach.

Polecenia do zarządzania ustawieniami centrum Webpubsub.

Polecenia

Nazwa Opis Typ Stan
az webpubsub hub create

Utwórz ustawienia centrum dla usługi WebPubSub lub Web PubSub dla Socket.IO w trybie bezserwerowym.

 Extension ogólna dostępność
az webpubsub hub delete

Usuń ustawienia centrum dla usługi WebPubSub.

 Extension ogólna dostępność
az webpubsub hub list

Wyświetl listę wszystkich ustawień centrum dla usługi WebPubSub.

 Extension ogólna dostępność
az webpubsub hub show

Pokaż ustawienia centrum dla usługi WebPubSub.

 Extension ogólna dostępność
az webpubsub hub update

Zaktualizuj ustawienia centrum dla usługi WebPubSub lub Web PubSub dla Socket.IO w trybie bezserwerowym.

 Extension ogólna dostępność

az webpubsub hub create

Utwórz ustawienia centrum dla usługi WebPubSub lub Web PubSub dla Socket.IO w trybie bezserwerowym.

az webpubsub hub create --hub-name
                        --name
                        --resource-group
                        [--allow-anonymous {false, true}]
                        [--event-handler]
                        [--websocket-keepalive]

Przykłady

Tworzenie ustawienia centrum z dwoma ustawieniami procedury obsługi zdarzeń

az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"

Tworzenie ustawienia centrum z dozwolonym połączeniem anonimowym

az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true

Parametry wymagane

--hub-name

Centrum do zarządzania.

--name -n

Nazwa elementu webpubsub.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--allow-anonymous

Ustaw, czy połączenia anonimowe są dozwolone dla tego centrum. Wartość True oznacza zezwalanie i fałsz oznacza odmowę.

Właściwość Wartość
Domyślna wartość: False
Dopuszczalne wartości: false, true
--event-handler

Element szablonu dla ustawień programu obsługi zdarzeń. Użyj wzorca key=value, aby ustawić właściwości. Obsługiwane klucze to "url-template", "user-event-pattern", "system-event", "auth-type" i "auth-resource". Ustawienie wielu wyników "system-event" powoduje, że tablica i dla innych właściwości tylko ostatni zestaw jest aktywny.

--websocket-keepalive

Interwał utrzymania aktywności protokołu WebSocket w sekundach dla wszystkich klientów w centrum. Prawidłowy zakres: od 1 do 120. Wartość domyślna to 20 sekund.

Właściwość Wartość
Domyślna wartość: 20
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az webpubsub hub delete

Usuń ustawienia centrum dla usługi WebPubSub.

az webpubsub hub delete [--hub-name]
                        [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--hub-name

Nazwa centrum.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--name -n

Nazwa elementu webpubsub.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az webpubsub hub list

Wyświetl listę wszystkich ustawień centrum dla usługi WebPubSub.

az webpubsub hub list --name
                      --resource-group

Parametry wymagane

--name -n

Nazwa elementu webpubsub.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az webpubsub hub show

Pokaż ustawienia centrum dla usługi WebPubSub.

az webpubsub hub show [--hub-name]
                      [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--hub-name

Nazwa centrum.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--name -n

Nazwa elementu webpubsub.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az webpubsub hub update

Zaktualizuj ustawienia centrum dla usługi WebPubSub lub Web PubSub dla Socket.IO w trybie bezserwerowym.

az webpubsub hub update --hub-name
                        [--add]
                        [--allow-anonymous {false, true}]
                        [--event-handler]
                        [--force-string]
                        [--ids]
                        [--name]
                        [--remove]
                        [--resource-group]
                        [--set]
                        [--subscription]
                        [--websocket-keepalive]

Przykłady

Aktualizowanie ustawień programu obsługi zdarzeń centrum

az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"

Aktualizacja zezwalania na anonimowe połączenie

az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true

Aktualizacja do gniazda internetowego utrzymuje interwał aktywności w sekundach (wartość domyślna to 20 sekund, minimum to 1, wartość maksymalna to 120)

az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --websocket-keepalive 30

Parametry wymagane

--hub-name

Centrum do zarządzania.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--add

Dodaj obiekt do listy obiektów, określając pary ścieżki i wartości klucza. Przykład: --add property.listProperty <key=value, string or JSON string>.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--allow-anonymous

Ustaw, czy połączenia anonimowe są dozwolone dla tego centrum. Wartość True oznacza zezwalanie i fałsz oznacza odmowę.

Właściwość Wartość
Dopuszczalne wartości: false, true
--event-handler

Element szablonu dla ustawień programu obsługi zdarzeń. Użyj wzorca key=value, aby ustawić właściwości. Obsługiwane klucze to "url-template", "user-event-pattern", "system-event", "auth-type" i "auth-resource". Ustawienie wielu wyników "system-event" powoduje, że tablica i dla innych właściwości tylko ostatni zestaw jest aktywny.

--force-string

W przypadku używania polecenia "set" lub "add" zachowaj literały ciągu zamiast próbować konwertować na format JSON.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: False
--ids

Co najmniej jeden identyfikator zasobu (rozdzielany spacjami). Powinien to być kompletny identyfikator zasobu, zawierający wszystkie informacje dotyczące argumentów „Identyfikator zasobu”. Należy podać argumenty --ids lub inne argumenty "Identyfikator zasobu".

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--name -n

Nazwa elementu webpubsub.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--remove

Usuń właściwość lub element z listy. Przykład: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--set

Zaktualizuj obiekt, określając ścieżkę właściwości i wartość do ustawienia. Przykład: --set property1.property2=<value>.

Właściwość Wartość
Grupa parametrów: Generic Update Arguments
Domyślna wartość: []
--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

Właściwość Wartość
Grupa parametrów: Resource Id Arguments
--websocket-keepalive

Interwał utrzymania aktywności protokołu WebSocket w sekundach dla wszystkich klientów w centrum. Prawidłowy zakres: od 1 do 120. Wartość domyślna to 20 sekund.

Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False