az webpubsub

  • Referenz

Hinweis

Diese Referenz ist Teil der Webpubsub-Erweiterung für die Azure CLI (Version 2.39.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az webpubsub-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Befehle zum Verwalten von Webpubsub.

Befehle

Name Beschreibung Typ Status
az webpubsub client

Befehle zum Verwalten von Clientverbindungen.

 Erweiterung Allgemein verfügbar
az webpubsub client start

Starten Sie eine interaktive Clientverbindung.

 Erweiterung Allgemein verfügbar
az webpubsub create

Erstellen Sie eine Webpubsub.

 Erweiterung Allgemein verfügbar
az webpubsub delete

Löschen eines Webpubsubs.

 Erweiterung Allgemein verfügbar
az webpubsub hub

Befehle zum Verwalten von Webpubsub-Hubeinstellungen.

 Erweiterung Allgemein verfügbar
az webpubsub hub create

Erstellen Sie Hubeinstellungen für den WebPubSub-Dienst.

 Erweiterung Allgemein verfügbar
az webpubsub hub delete

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

 Erweiterung Allgemein verfügbar
az webpubsub hub list

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

 Erweiterung Allgemein verfügbar
az webpubsub hub show

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

 Erweiterung Allgemein verfügbar
az webpubsub hub update

Aktualisieren Sie Hubeinstellungen für den WebPubSub-Dienst.

 Erweiterung Allgemein verfügbar
az webpubsub key

Befehle zum Verwalten von Webpubsub-Tasten.

 Erweiterung Allgemein verfügbar
az webpubsub key regenerate

Generieren Sie Schlüssel für einen WebPubSub-Dienst neu.

 Erweiterung Allgemein verfügbar
az webpubsub key show

Anzeigen von Vernetzungszeichenfolgen und Schlüsseln für einen WebPubSub-Dienst.

 Erweiterung Allgemein verfügbar
az webpubsub list

Webpubsub auflisten.

 Erweiterung Allgemein verfügbar
az webpubsub list-skus

Listet alle verfügbaren Skus der Ressource auf.

 Erweiterung Allgemein verfügbar
az webpubsub list-usage

Ressourcennutzungskontingente nach Speicherort auflisten.

 Erweiterung Allgemein verfügbar
az webpubsub network-rule

Befehle zum Verwalten von Webpubsub-Netzwerkregeln.

 Erweiterung Allgemein verfügbar
az webpubsub network-rule show

Rufen Sie die Netzwerkzugriffskontrolle des WebPubSub-Diensts ab.

 Erweiterung Allgemein verfügbar
az webpubsub network-rule update

Aktualisieren Sie die Netzwerkzugriffskontrolle des WebPubSub-Diensts.

 Erweiterung Allgemein verfügbar
az webpubsub replica

Verwalten von Replikateinstellungen.

 Erweiterung Allgemein verfügbar
az webpubsub replica create

Erstellen Sie ein Replikat des Webpubsub-Diensts.

 Erweiterung Allgemein verfügbar
az webpubsub replica delete

Löschen eines Replikats des WebPubSub-Diensts.

 Erweiterung Allgemein verfügbar
az webpubsub replica list

Auflisten von Replikaten des Webpubsub-Diensts.

 Erweiterung Allgemein verfügbar
az webpubsub replica show

Zeigen Sie die Details eines Replikats an.

 Erweiterung Allgemein verfügbar
az webpubsub restart

Starten Sie einen Webpubsub neu.

 Erweiterung Allgemein verfügbar
az webpubsub service

Befehle zum Verwalten des Webpubsub-Diensts.

 Erweiterung Allgemein verfügbar
az webpubsub service broadcast

Übertragen von Nachrichten an den Hub. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service connection

Befehle zum Verwalten von Webpubsub-Dienstverbindungen.

 Erweiterung Allgemein verfügbar
az webpubsub service connection close

Schließen Sie eine bestimmte Clientverbindung. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service connection exist

Überprüfen Sie, ob die Clientverbindung vorhanden ist.

 Erweiterung Allgemein verfügbar
az webpubsub service connection send

Senden sie eine Nachricht an eine Verbindung. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service group

Befehle zum Verwalten von Webpubsub-Dienstgruppen.

 Erweiterung Allgemein verfügbar
az webpubsub service group add-connection

Fügen Sie eine Verbindung zur Gruppe hinzu. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service group add-user

Fügen Sie einen Benutzer zur Gruppe hinzu. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service group remove-connection

Entfernen sie eine Verbindung aus der Gruppe. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service group remove-user

Entfernen sie einen Benutzer aus der Gruppe. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service group send

Senden sie eine Nachricht an eine Gruppe. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service permission

Befehle zum Verwalten von Webpubsub-Dienstberechtigungen.

 Erweiterung Allgemein verfügbar
az webpubsub service permission check

Überprüfen Sie, ob eine Verbindung über die Berechtigung für die angegebene Gruppe verfügt.

 Erweiterung Allgemein verfügbar
az webpubsub service permission grant

Erteilen Einer Gruppenberechtigung für die Verbindung. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service permission revoke

Widerrufen einer Gruppenberechtigung aus der Verbindung. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub service user

Befehle zum Verwalten von Webpubsub-Dienstbenutzern.

 Erweiterung Allgemein verfügbar
az webpubsub service user exist

Überprüfen Sie, ob Clientverbindungen für den angegebenen Benutzer verbunden sind.

 Erweiterung Allgemein verfügbar
az webpubsub service user send

Senden Sie eine Nachricht an den Benutzer. Wenn der Vorgang fehlschlägt, wird ein Fehler ausgelöst.

 Erweiterung Allgemein verfügbar
az webpubsub show

Details eines Webpubsubs anzeigen.

 Erweiterung Allgemein verfügbar
az webpubsub update

Aktualisieren eines Webpubsubs.

 Erweiterung Allgemein verfügbar

az webpubsub create

Erstellen Sie eine Webpubsub.

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--tags]
                    [--unit-count]

Beispiele

Erstellen Sie einen WebPubSub-Dienst mit Standard-SKU und Einheit 2.

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2

Erstellen Sie ein Web PubSub für Socket.IO mit Premium-SKU und Einheit 1.

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO

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.

--sku

Der SKU-Name des Webpubsub-Diensts. Zulässige Werte: Free_F1, Standard_S1, Premium_P1.

Optionale Parameter

--kind

Die Art des Webpubsub-Diensts. Zulässige Werte: WebPubSub, SocketIO.

--location -l

Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--unit-count

Die Anzahl der Webpubsub-Diensteinheiten.

Standardwert: 1
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az webpubsub delete

Löschen eines Webpubsubs.

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

Optionale Parameter

--ids

Eine oder mehrere 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.

--name -n

Name des Webpubsub.

--resource-group -g

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az webpubsub list

Webpubsub auflisten.

az webpubsub list [--resource-group]

Optionale Parameter

--resource-group -g

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

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az webpubsub list-skus

Listet alle verfügbaren Skus der Ressource auf.

az webpubsub list-skus [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

Optionale Parameter

--ids

Eine oder mehrere 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.

--name -n

Name des Webpubsub.

--resource-group -g

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az webpubsub list-usage

Ressourcennutzungskontingente nach Speicherort auflisten.

az webpubsub list-usage --location

Erforderliche Parameter

--location -l

Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az webpubsub restart

Starten Sie einen Webpubsub neu.

az webpubsub restart [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Optionale Parameter

--ids

Eine oder mehrere 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.

--name -n

Name des Webpubsub.

--resource-group -g

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az webpubsub show

Details eines Webpubsubs anzeigen.

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

Optionale Parameter

--ids

Eine oder mehrere 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.

--name -n

Name des Webpubsub.

--resource-group -g

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az webpubsub update

Aktualisieren eines Webpubsubs.

az webpubsub update [--add]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

Beispiele

Aktualisieren Sie einen WebPubSub-Dienst auf Einheit 10.

az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10

Optionale Parameter

--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>.

Standardwert: []
--force-string

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

Standardwert: False
--ids

Eine oder mehrere 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.

--name -n

Name des Webpubsub.

--remove

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

Standardwert: []
--resource-group -g

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

--set

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

Standardwert: []
--sku

Der SKU-Name des Webpubsub-Diensts. Zulässige Werte: Free_F1, Standard_S1, Premium_P1.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--tags

Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--unit-count

Die Anzahl der Webpubsub-Diensteinheiten.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.