Delen via

az webpubsub hub

Note

Deze verwijzing maakt deel uit van de webpubsub-extensie voor de Azure CLI (versie 2.56.0 of hoger). De extensie wordt automatisch geïnstalleerd wanneer u een az webpubsub hub opdracht uitvoert. Meer informatie over uitbreidingen.

Opdrachten voor het beheren van instellingen voor de Webpubsub-hub.

Opdracht

Name Description Type Status
az webpubsub hub create

Maak hubinstellingen voor WebPubSub Service of Web PubSub voor Socket.IO in de serverloze modus.

 Extension GA
az webpubsub hub delete

Hubinstellingen voor WebPubSub Service verwijderen.

 Extension GA
az webpubsub hub list

Geef alle hubinstellingen voor WebPubSub Service weer.

 Extension GA
az webpubsub hub show

Hubinstellingen weergeven voor WebPubSub Service.

 Extension GA
az webpubsub hub update

Hubinstellingen voor WebPubSub Service of Web PubSub bijwerken voor Socket.IO in de serverloze modus.

 Extension GA

az webpubsub hub create

Maak hubinstellingen voor WebPubSub Service of Web PubSub voor Socket.IO in de serverloze modus.

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

Voorbeelden

Een hub-instelling maken met twee instellingen voor gebeurtenis-handler

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"

Een hub-instelling maken waarvoor anonieme verbinding is toegestaan

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

Vereiste parameters

--hub-name

De hub die moet worden beheerd.

--name -n

Naam van de webpubsub.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--allow-anonymous

Instellen of anonieme verbindingen zijn toegestaan voor deze hub. Waar betekent toestaan en Onwaar betekent weigeren.

Eigenschap Waarde
Default value: False
Geaccepteerde waarden: false, true
--event-handler

Sjabloonitem voor instellingen voor gebeurtenis-handler. Gebruik het patroon key=value om eigenschappen in te stellen. Ondersteunde sleutels zijn 'url-template', 'user-event-pattern', 'system-event', 'auth-type' en 'auth-resource'. Het instellen van meerdere systeemgebeurtenissen resulteert in een matrix en voor andere eigenschappen wordt alleen de laatste set actief.

--websocket-keepalive

Het keep-alive-interval van WebSocket in seconden voor alle clients in de hub. Geldig bereik: 1 tot 120. De standaardwaarde is 20 seconden.

Eigenschap Waarde
Default value: 20
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az webpubsub hub delete

Hubinstellingen voor WebPubSub Service verwijderen.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--hub-name

Naam van de hub.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name -n

Naam van de webpubsub.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az webpubsub hub list

Geef alle hubinstellingen voor WebPubSub Service weer.

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

Vereiste parameters

--name -n

Naam van de webpubsub.

--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az webpubsub hub show

Hubinstellingen weergeven voor WebPubSub Service.

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

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--hub-name

Naam van de hub.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name -n

Naam van de webpubsub.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False

az webpubsub hub update

Hubinstellingen voor WebPubSub Service of Web PubSub bijwerken voor Socket.IO in de serverloze 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]

Voorbeelden

Instellingen voor gebeurtenis-handler van een hub bijwerken

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"

Bijwerken om anonieme verbinding toe te staan

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

Update naar websocket houdt het interval in seconden in stand (de standaardwaarde is 20 seconden, minimaal 1, maximum is 120)

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

Vereiste parameters

--hub-name

De hub die moet worden beheerd.

Optionele parameters

De volgende parameters zijn optioneel, maar afhankelijk van de context kunnen een of meer parameters vereist zijn om de opdracht uit te voeren.

--add

Voeg een object toe aan een lijst met objecten door een pad- en sleutelwaardeparen op te geven. Voorbeeld: --add property.listProperty <key=value, string or JSON string>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--allow-anonymous

Instellen of anonieme verbindingen zijn toegestaan voor deze hub. Waar betekent toestaan en Onwaar betekent weigeren.

Eigenschap Waarde
Geaccepteerde waarden: false, true
--event-handler

Sjabloonitem voor instellingen voor gebeurtenis-handler. Gebruik het patroon key=value om eigenschappen in te stellen. Ondersteunde sleutels zijn 'url-template', 'user-event-pattern', 'system-event', 'auth-type' en 'auth-resource'. Het instellen van meerdere systeemgebeurtenissen resulteert in een matrix en voor andere eigenschappen wordt alleen de laatste set actief.

--force-string

Wanneer u 'set' of 'toevoegen' gebruikt, behoudt u letterlijke tekenreeksen in plaats van te converteren naar JSON.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: False
--ids

Een of meer resource-id's (met spatie gescheiden). Dit moet een volledige resource-id zijn die alle informatie over de argumenten Resource-id bevat. U moet ofwel --id's of andere 'Resource Id'-argumenten opgeven.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--name -n

Naam van de webpubsub.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--remove

Een eigenschap of element uit een lijst verwijderen. Voorbeeld: --remove property.list <indexToRemove> OF --remove propertyToRemove.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--resource-group -g

Naam van resourcegroep. U kunt de standaardgroep configureren met behulp van az configure --defaults group=<name>.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--set

Werk een object bij door een eigenschapspad en waarde op te geven die u wilt instellen. Voorbeeld: --set property1.property2=<value>.

Eigenschap Waarde
Parametergroep: Generic Update Arguments
Default value: []
--subscription

Naam of id van abonnement. U kunt het standaardabonnement configureren met behulp van az account set -s NAME_OR_ID.

Eigenschap Waarde
Parametergroep: Resource Id Arguments
--websocket-keepalive

Het keep-alive-interval van WebSocket in seconden voor alle clients in de hub. Geldig bereik: 1 tot 120. De standaardwaarde is 20 seconden.

Globale parameters
--debug

Vergroot de uitgebreidheid van logboekregistratie om alle logboeken voor foutopsporing weer te geven.

Eigenschap Waarde
Default value: False
--help -h

Dit Help-bericht weergeven en afsluiten.

--only-show-errors

Alleen fouten weergeven, waarschuwingen onderdrukken.

Eigenschap Waarde
Default value: False
--output -o

Uitvoerindeling.

Eigenschap Waarde
Default value: json
Geaccepteerde waarden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.

--verbose

Vergroot de uitgebreidheid van logboekregistratie. Gebruik --debug voor volledige foutopsporingslogboeken.

Eigenschap Waarde
Default value: False