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 instalará automaticamente a 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

Nome	Description	Tipo	Status
az webpubsub hub create	Crie configurações de hub para o Serviço WebPubSub ou o Web PubSub para Socket.IO no modo sem servidor.	Extension	GA
az webpubsub hub delete	Excluir configurações de hub do Serviço WebPubSub.	Extension	GA
az webpubsub hub list	Listar todas as configurações de hub do Serviço WebPubSub.	Extension	GA
az webpubsub hub show	Mostrar as configurações de hub do Serviço WebPubSub.	Extension	GA
az webpubsub hub update	Atualize as configurações do hub para o Serviço WebPubSub ou o Web PubSub para Socket.IO no modo sem servidor.	Extension	GA

az webpubsub hub create

Crie configurações de hub para o Serviço WebPubSub ou o 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 Exigidos

--hub-name

O hub a ser gerenciado.

--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 se tornar obrigatórios para que o comando seja executado com sucesso.

--allow-anonymous

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

Propriedade	Valor
Valor padrão:	False
Valores aceitos:	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 com suporte 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, somente o último conjunto fica ativo.

--websocket-keepalive

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

Propriedade	Valor
Valor padrão:	20

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az webpubsub hub delete

Excluir configurações de hub do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--hub-name

Nome do hub.

Propriedade	Valor
Grupo de parâmetros:	Resource Id Arguments

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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

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

Propriedade	Valor
Valor padrão:	False

az webpubsub hub list

Listar todas as configurações de hub do Serviço WebPubSub.

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

Parâmetros Exigidos

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

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade	Valor
Valor padrão:	False

az webpubsub hub show

Mostrar as configurações de hub do 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 se tornar obrigatórios para que o comando seja executado com sucesso.

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

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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

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

Propriedade	Valor
Valor padrão:	False

az webpubsub hub update

Atualize as configurações do hub para o Serviço WebPubSub ou o 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"

Atualizar para permitir conexão anônima

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

Atualizar para o intervalo de manter vivo o 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 Exigidos

--hub-name

O hub a ser gerenciado.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--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
Valor padrão:	[]

--allow-anonymous

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

Propriedade	Valor
Valores aceitos:	false, true

--event-handler

--force-string

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

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	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> OR --remove propertyToRemove.

Propriedade	Valor
Grupo de parâmetros:	Generic Update Arguments
Valor padrão:	[]

--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
Valor padrão:	[]

--subscription

Nome ou ID da assinatura. 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 de keep-alive do WebSocket em segundos para todos os clientes no hub. Intervalo válido: 1 a 120. Padrão para 20 segundos.

Parâmetros Globais

--debug

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

Propriedade	Valor
Valor padrão:	False

--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade	Valor
Valor padrão:	False

--output -o

Formato de saída.

Propriedade	Valor
Valor padrão:	json
Valores aceitos:	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

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

Propriedade	Valor
Valor padrão:	False

Comentários

Esta página foi útil?

Compartilhar via

az webpubsub hub

Comandos

az webpubsub hub create

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

az webpubsub hub delete

Parâmetros Opcionais

az webpubsub hub list

Parâmetros Exigidos

az webpubsub hub show

Parâmetros Opcionais

az webpubsub hub update

Exemplos

Parâmetros Exigidos

Parâmetros Opcionais

Comentários