az webpubsub

  • Référence

Remarque

Cette référence fait partie de l’extension webpubsub pour Azure CLI (version 2.39.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande az webpubsub . En savoir plus sur les extensions.

Commandes pour gérer Webpubsub.

Commandes

Nom Description Type Statut
az webpubsub client

Commandes pour gérer les connexions clientes.

 Extension GA
az webpubsub client start

Démarrez une connexion client interactive.

 Extension GA
az webpubsub create

Créez un webpubsub.

 Extension GA
az webpubsub delete

Supprimez un webpubsub.

 Extension GA
az webpubsub hub

Commandes pour gérer les paramètres du hub Webpubsub.

 Extension GA
az webpubsub hub create

Crée les paramètres de hub pour le service WebPubSub.

 Extension GA
az webpubsub hub delete

Supprime les paramètres de hub pour le service WebPubSub.

 Extension GA
az webpubsub hub list

Répertorie tous les paramètres de hub pour le service WebPubSub.

 Extension GA
az webpubsub hub show

Affiche les paramètres de hub pour le service WebPubSub.

 Extension GA
az webpubsub hub update

Met à jour les paramètres de hub pour le service WebPubSub.

 Extension GA
az webpubsub key

Commandes pour gérer les clés Webpubsub.

 Extension GA
az webpubsub key regenerate

Régénérer des clés pour un service WebPubSub.

 Extension GA
az webpubsub key show

Afficher les chaînes et les clés connetion pour un service WebPubSub.

 Extension GA
az webpubsub list

Répertorier Webpubsub.

 Extension GA
az webpubsub list-skus

Répertorier toutes les références SKU disponibles de la ressource.

 Extension GA
az webpubsub list-usage

Répertoriez les quotas d’utilisation des ressources par emplacement.

 Extension GA
az webpubsub network-rule

Commandes pour gérer les règles réseau Webpubsub.

 Extension GA
az webpubsub network-rule show

Obtenez le contrôle d’accès réseau du service WebPubSub.

 Extension GA
az webpubsub network-rule update

Mettez à jour le contrôle d’accès réseau du service WebPubSub.

 Extension GA
az webpubsub replica

Gérer les paramètres du réplica.

 Extension GA
az webpubsub replica create

Créez un réplica du service Webpubsub.

 Extension GA
az webpubsub replica delete

Supprimez un réplica du service WebPubSub.

 Extension GA
az webpubsub replica list

Répertorier les réplicas du service Webpubsub.

 Extension GA
az webpubsub replica show

Afficher les détails d’un réplica.

 Extension GA
az webpubsub restart

Redémarrez un webpubsub.

 Extension GA
az webpubsub service

Commandes pour gérer le service Webpubsub.

 Extension GA
az webpubsub service broadcast

Diffuser des messages vers le hub. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service connection

Commandes pour gérer les connexions de service Webpubsub.

 Extension GA
az webpubsub service connection close

Fermez une connexion client spécifique. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service connection exist

Vérifiez si la connexion du client existe.

 Extension GA
az webpubsub service connection send

Envoyez un message à la connexion. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service group

Commandes pour gérer les groupes de services Webpubsub.

 Extension GA
az webpubsub service group add-connection

Ajoutez une connexion au groupe. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service group add-user

Ajoutez un utilisateur au groupe. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service group remove-connection

Supprimez une connexion du groupe. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service group remove-user

Supprimez un utilisateur du groupe. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service group send

Envoyez un message au groupe. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service permission

Commandes pour gérer les autorisations du service Webpubsub.

 Extension GA
az webpubsub service permission check

Vérifiez si une connexion est autorisée au groupe spécifié.

 Extension GA
az webpubsub service permission grant

Accordez une autorisation de groupe à la connexion. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service permission revoke

Révoquez une autorisation de groupe de la connexion. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub service user

Commandes pour gérer les utilisateurs du service Webpubsub.

 Extension GA
az webpubsub service user exist

Vérifiez s’il existe des connexions clientes connectées pour l’utilisateur donné.

 Extension GA
az webpubsub service user send

Envoyez un message à l’utilisateur. Erreur levée en cas d’échec de l’opération.

 Extension GA
az webpubsub show

Afficher les détails d’un webpubsub.

 Extension GA
az webpubsub update

Mettez à jour un webpubsub.

 Extension GA

az webpubsub create

Créez un webpubsub.

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

Exemples

Créez un service WebPubSub avec la référence SKU standard et l’unité 2.

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

Créez un web PubSub pour Socket.IO avec la référence SKU Premium et l’unité 1.

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

Paramètres obligatoires

--name -n

Nom du webpubsub.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--sku

Nom de la référence SKU du service webpubsub. Valeurs autorisées : Free_F1, Standard_S1, Premium_P1.

Paramètres facultatifs

--kind

Type du service webpubsub. Valeurs autorisées : WebPubSub, SocketIO.

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--unit-count

Nombre d’unités de service webpubsub.

valeur par défaut: 1
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az webpubsub delete

Supprimez un webpubsub.

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

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name -n

Nom du webpubsub.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az webpubsub list

Répertorier Webpubsub.

az webpubsub list [--resource-group]

Paramètres facultatifs

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az webpubsub list-skus

Répertorier toutes les références SKU disponibles de la ressource.

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

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name -n

Nom du webpubsub.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az webpubsub list-usage

Répertoriez les quotas d’utilisation des ressources par emplacement.

az webpubsub list-usage --location

Paramètres obligatoires

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az webpubsub restart

Redémarrez un webpubsub.

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

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name -n

Nom du webpubsub.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az webpubsub show

Afficher les détails d’un webpubsub.

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

Paramètres facultatifs

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name -n

Nom du webpubsub.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az webpubsub update

Mettez à jour un webpubsub.

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

Exemples

Mettez à jour un service WebPubSub à l’unité 10.

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

Paramètres facultatifs

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string or JSON string>.

valeur par défaut: []
--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--name -n

Nom du webpubsub.

--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list <indexToRemove> OR --remove propertyToRemove.

valeur par défaut: []
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=<value>.

valeur par défaut: []
--sku

Nom de la référence SKU du service webpubsub. Valeurs autorisées : Free_F1, Standard_S1, Premium_P1.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--unit-count

Nombre d’unités de service webpubsub.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.