az webpubsub hub

Note

Essa referência faz parte da extensão webpubsub para a CLI do Azure (versão 2.56.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az webpubsub hub. Saiba mais sobre extensões.

Comandos para gerenciar as configurações do hub Webpubsub.

Comandos

Name	Description	Tipo	Status
az webpubsub hub create	Crie configurações de hub para o Serviço WebPubSub ou Web PubSub para Socket.IO no Modo Sem Servidor.	Extension	disponibilidade geral
az webpubsub hub delete	Exclua as configurações de hub para o Serviço WebPubSub.	Extension	disponibilidade geral
az webpubsub hub list	Liste todas as configurações de hub para o Serviço WebPubSub.	Extension	disponibilidade geral
az webpubsub hub show	Mostrar configurações de hub para o Serviço WebPubSub.	Extension	disponibilidade geral
az webpubsub hub update	Atualize as configurações do hub para o Serviço WebPubSub ou Web PubSub para Socket.IO no Modo Sem Servidor.	Extension	disponibilidade geral

az webpubsub hub create

Crie configurações de hub para o Serviço WebPubSub ou Web PubSub para Socket.IO no Modo Sem Servidor.

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

Exemplos

Criar uma configuração de hub com duas configurações de manipulador de eventos

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"

Criar uma configuração de hub com conexão anônima permitida

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

Parâmetros Obrigatórios

--hub-name

O hub para gerenciar.

--name -n

Nome do webpubsub.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--allow-anonymous

Defina se conexões anônimas são permitidas para esse hub. Verdadeiro significa permitir e Falso significa negar.

Propriedade	Valor
Default value:	False
Valores aceites:	false, true

--event-handler

Item de modelo para configurações do manipulador de eventos. Use o padrão key=value para definir propriedades. As chaves suportadas são "url-template", "user-event-pattern", "system-event", "auth-type" e "auth-resource". A configuração de vários "eventos do sistema" resulta em uma matriz e, para outras propriedades, apenas o último conjunto fica ativo.

--websocket-keepalive

O intervalo keep-alive do WebSocket em segundos para todos os clientes no hub. Intervalo válido: 1 a 120. O padrão é de 20 segundos.

Propriedade	Valor
Default value:	20

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az webpubsub hub delete

Exclua as configurações de hub para o Serviço WebPubSub.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--hub-name

Nome do hub.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

Nome do webpubsub.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az webpubsub hub list

Liste todas as configurações de hub para o Serviço WebPubSub.

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

Parâmetros Obrigatórios

--name -n

Nome do webpubsub.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az webpubsub hub show

Mostrar configurações de hub para o Serviço WebPubSub.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--hub-name

Nome do hub.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

Nome do webpubsub.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

az webpubsub hub update

Atualize as configurações do hub para o Serviço WebPubSub ou Web PubSub para Socket.IO no Modo Sem Servidor.

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

Exemplos

Atualizar as configurações do manipulador de eventos de um hub

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"

Atualização para permitir conexão anônima

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

Atualização para o intervalo de manutenção de vida do soquete da Web em segundos (o padrão é 20 segundos, o mínimo é 1, o máximo é 120)

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

Parâmetros Obrigatórios

--hub-name

O hub para gerenciar.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Default value:	[]

--allow-anonymous

Defina se conexões anônimas são permitidas para esse hub. Verdadeiro significa permitir e Falso significa negar.

Propriedade	Valor
Valores aceites:	false, true

--event-handler

--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Default value:	False

--ids

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--name -n

Nome do webpubsub.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Default value:	[]

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Default value:	[]

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--websocket-keepalive

O intervalo keep-alive do WebSocket em segundos para todos os clientes no hub. Intervalo válido: 1 a 120. O padrão é de 20 segundos.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade	Valor
Default value:	False

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Default value:	False

--output -o

Formato de saída.

Propriedade	Valor
Default value:	json
Valores aceites:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade	Valor
Default value:	False

Feedback

Esta página foi útil?

Partilhar via

az webpubsub hub

Comandos

az webpubsub hub create

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

az webpubsub hub delete

Parâmetros Opcionais

az webpubsub hub list

Parâmetros Obrigatórios

az webpubsub hub show

Parâmetros Opcionais

az webpubsub hub update

Exemplos

Parâmetros Obrigatórios

Parâmetros Opcionais

Feedback