az webpubsub hub

Note

Tento odkaz je součástí rozšíření webpubsub pro Azure CLI (verze 2.56.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az webpubsub hub. Přečtěte si další informace o rozšířeních.

Příkazy pro správu nastavení centra Webpubsub

Příkazy

Name Description Typ Stav
az webpubsub hub create

Vytvořte nastavení centra pro službu WebPubSub nebo Web PubSub pro Socket.IO v bezserverovém režimu.

 Extension GA
az webpubsub hub delete

Odstraňte nastavení centra pro službu WebPubSub.

 Extension GA
az webpubsub hub list

Zobrazí seznam všech nastavení centra pro službu WebPubSub.

 Extension GA
az webpubsub hub show

Zobrazit nastavení centra pro službu WebPubSub.

 Extension GA
az webpubsub hub update

Aktualizujte nastavení centra pro službu WebPubSub nebo Web PubSub pro Socket.IO v bezserverovém režimu.

 Extension GA

az webpubsub hub create

Vytvořte nastavení centra pro službu WebPubSub nebo Web PubSub pro Socket.IO v bezserverovém režimu.

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

Příklady

Vytvoření nastavení centra se dvěma nastaveními obslužné rutiny událostí

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"

Vytvoření nastavení centra s povoleným anonymním připojením

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

Povinné parametry

--hub-name

Centrum, které chcete spravovat.

--name -n

Název webpubsub.

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--allow-anonymous

Nastavte, jestli jsou pro toto centrum povolená anonymní připojení. Pravda znamená povolit a Nepravda znamená odepření.

Vlastnost Hodnota
Default value: False
Přípustné hodnoty: false, true
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--event-handler

Položka šablony pro nastavení obslužné rutiny události K nastavení vlastností použijte vzor key=value. Podporované klíče jsou url-template, user-event-pattern, system-event, auth-type a auth-resource. Nastavení více výsledků "system-event" má za následek pole a pro další vlastnosti, pouze poslední sada se aktivuje.

--websocket-keepalive

Interval udržování protokolu WebSocket v sekundách pro všechny klienty v centru. Platný rozsah: 1 až 120. Výchozí hodnota je 20 sekund.

Vlastnost Hodnota
Default value: 20
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az webpubsub hub delete

Odstraňte nastavení centra pro službu WebPubSub.

az webpubsub hub delete [--acquire-policy-token]
                        [--change-reference]
                        [--hub-name]
                        [--ids]
                        [--name]
                        [--resource-group]
                        [--subscription]

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--hub-name

Název centra

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--name -n

Název webpubsub.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az webpubsub hub list

Zobrazí seznam všech nastavení centra pro službu WebPubSub.

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

Povinné parametry

--name -n

Název webpubsub.

--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az webpubsub hub show

Zobrazit nastavení centra pro službu WebPubSub.

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

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--hub-name

Název centra

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--name -n

Název webpubsub.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False

az webpubsub hub update

Aktualizujte nastavení centra pro službu WebPubSub nebo Web PubSub pro Socket.IO v bezserverovém režimu.

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

Příklady

Aktualizace nastavení obslužné rutiny události centra

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"

Aktualizace pro povolení anonymního připojení

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

Aktualizace na interval uchování webového soketu v sekundách (výchozí hodnota je 20 sekund, minimum je 1, maximum je 120)

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

Povinné parametry

--hub-name

Centrum, které chcete spravovat.

Volitelné parametry

Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.

--acquire-policy-token

Získání tokenu Azure Policy automaticky pro tuto operaci prostředku

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--add

Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--allow-anonymous

Nastavte, jestli jsou pro toto centrum povolená anonymní připojení. Pravda znamená povolit a Nepravda znamená odepření.

Vlastnost Hodnota
Přípustné hodnoty: false, true
--change-reference

Související referenční ID odkazu na změnu pro tuto operaci prostředku.

Vlastnost Hodnota
Skupina parametrů: Global Policy Arguments
--event-handler

Položka šablony pro nastavení obslužné rutiny události K nastavení vlastností použijte vzor key=value. Podporované klíče jsou url-template, user-event-pattern, system-event, auth-type a auth-resource. Nastavení více výsledků "system-event" má za následek pole a pro další vlastnosti, pouze poslední sada se aktivuje.

--force-string

Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: False
--ids

Jedno nebo více ID prostředků (oddělené mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat buď argumenty --ids, nebo jiné argumenty 'ID prostředku'.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--name -n

Název webpubsub.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--remove

Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--resource-group -g

Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--set

Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.

Vlastnost Hodnota
Skupina parametrů: Generic Update Arguments
Default value: []
--subscription

Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Vlastnost Hodnota
Skupina parametrů: Resource Id Arguments
--websocket-keepalive

Interval udržování protokolu WebSocket v sekundách pro všechny klienty v centru. Platný rozsah: 1 až 120. Výchozí hodnota je 20 sekund.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

Vlastnost Hodnota
Default value: False
--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazit pouze chyby, potlačit upozornění.

Vlastnost Hodnota
Default value: False
--output -o

Výstupní formát

Vlastnost Hodnota
Default value: json
Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

Vlastnost Hodnota
Default value: False