Freigeben über

az webpubsub hub

Note

Diese Referenz ist Teil der Webpubsub-Erweiterung für die Azure CLI (Version 2.56.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az webpubsub hub Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Befehle zum Verwalten von Webpubsub-Hubeinstellungen.

Befehle

Name Beschreibung Typ Status
az webpubsub hub create

Erstellen Sie Hubeinstellungen für den WebPubSub-Dienst oder Web PubSub für Socket.IO im Serverlosen Modus.

 Extension GA
az webpubsub hub delete

Löschen Sie Hubeinstellungen für den WebPubSub-Dienst.

 Extension GA
az webpubsub hub list

Listen Sie Hubeinstellungen für den WebPubSub-Dienst auf.

 Extension GA
az webpubsub hub show

Zeigen Sie Hubeinstellungen für den WebPubSub-Dienst an.

 Extension GA
az webpubsub hub update

Aktualisieren Sie Hubeinstellungen für webPubSub Service oder Web PubSub für Socket.IO im Serverlosen Modus.

 Extension GA

az webpubsub hub create

Erstellen Sie Hubeinstellungen für den WebPubSub-Dienst oder Web PubSub für Socket.IO im Serverlosen Modus.

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

Beispiele

Erstellen einer Hubeinstellung mit zwei Ereignishandlereinstellungen

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"

Erstellen einer Hubeinstellung mit zulässiger anonymer Verbindung

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

Erforderliche Parameter

--hub-name

Der zu verwaltende Hub.

--name -n

Name des Webpubsub.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--allow-anonymous

Legen Sie fest, ob anonyme Verbindungen für diesen Hub zulässig sind. "Wahr" bedeutet "Zulassen" und "Falsch" bedeutet "Verweigern".

Eigenschaft Wert
Standardwert: False
Zulässige Werte: false, true
--event-handler

Vorlagenelement für Ereignishandlereinstellungen. Verwenden Sie das Schlüssel=Wertmuster, um Eigenschaften festzulegen. Unterstützte Schlüssel sind "url-template", "user-event-pattern", "system-event", "auth-type" und "auth-resource". Das Festlegen mehrerer "Systemereignisse" führt zu einem Array und für andere Eigenschaften wird nur der letzte Satz aktiv.

--websocket-keepalive

Das WebSocket-Keep-Alive-Intervall in Sekunden für alle Clients im Hub. Gültiger Bereich: 1 bis 120. Der Standardwert ist 20 Sekunden.

Eigenschaft Wert
Standardwert: 20
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az webpubsub hub delete

Löschen Sie Hubeinstellungen für den WebPubSub-Dienst.

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--hub-name

Name des Hubs.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--name -n

Name des Webpubsub.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az webpubsub hub list

Listen Sie Hubeinstellungen für den WebPubSub-Dienst auf.

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

Erforderliche Parameter

--name -n

Name des Webpubsub.

--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az webpubsub hub show

Zeigen Sie Hubeinstellungen für den WebPubSub-Dienst an.

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

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--hub-name

Name des Hubs.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--name -n

Name des Webpubsub.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az webpubsub hub update

Aktualisieren Sie Hubeinstellungen für webPubSub Service oder Web PubSub für Socket.IO im Serverlosen Modus.

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

Beispiele

Aktualisieren der Ereignishandlereinstellungen eines Hubs

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"

Aktualisieren, um anonyme Verbindung zuzulassen

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

Aktualisierung des Websocket-Keep-Alive-Intervalls in Sekunden (Standardwert ist 20 Sekunden, Mindestwert 1, Maximalwert 120)

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

Erforderliche Parameter

--hub-name

Der zu verwaltende Hub.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--add

Fügen Sie einer Liste von Objekten ein Objekt hinzu, indem Sie ein Pfad- und Schlüsselwertpaar angeben. Beispiel: --add property.listProperty <key=value, string or JSON string>.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
--allow-anonymous

Legen Sie fest, ob anonyme Verbindungen für diesen Hub zulässig sind. "Wahr" bedeutet "Zulassen" und "Falsch" bedeutet "Verweigern".

Eigenschaft Wert
Zulässige Werte: false, true
--event-handler

Vorlagenelement für Ereignishandlereinstellungen. Verwenden Sie das Schlüssel=Wertmuster, um Eigenschaften festzulegen. Unterstützte Schlüssel sind "url-template", "user-event-pattern", "system-event", "auth-type" und "auth-resource". Das Festlegen mehrerer "Systemereignisse" führt zu einem Array und für andere Eigenschaften wird nur der letzte Satz aktiv.

--force-string

Wenn Sie "set" oder "add" verwenden, behalten Sie Zeichenfolgenliterale bei, anstatt zu versuchen, in JSON zu konvertieren.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: False
--ids

Mindestens eine Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--name -n

Name des Webpubsub.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--remove

Entfernen sie eine Eigenschaft oder ein Element aus einer Liste. Beispiel: --remove property.list <indexToRemove> ODER --remove propertyToRemove.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
--resource-group -g

Name der Ressourcengruppe. Sie können die Standardgruppe mit az configure --defaults group=<name>konfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--set

Aktualisieren Sie ein Objekt, indem Sie einen festzulegenden Eigenschaftspfad und -wert angeben. Beispiel: --set property1.property2=<value>.

Eigenschaft Wert
Parametergruppe: Generic Update Arguments
Standardwert: []
--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

Eigenschaft Wert
Parametergruppe: Resource Id Arguments
--websocket-keepalive

Das WebSocket-Keep-Alive-Intervall in Sekunden für alle Clients im Hub. Gültiger Bereich: 1 bis 120. Der Standardwert ist 20 Sekunden.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False