az apim product

Gérer les produits de gestion des API Azure.

Commandes

Nom	Description	Type	État
az apim product api	Gérer les API du produit Gestion des API Azure.	Core	GA
az apim product api add	Ajoutez une API au produit spécifié.	Core	GA
az apim product api check	Vérifie que l’entité API spécifiée par l’identificateur est associée à l’entité Product.	Core	GA
az apim product api delete	Supprime l’API spécifiée du produit spécifié.	Core	GA
az apim product api list	Répertorie une collection des API associées à un produit.	Core	GA
az apim product create	Crée un produit.	Core	GA
az apim product delete	Supprimez le produit.	Core	GA
az apim product list	Répertorie une collection de produits dans l’instance de service spécifiée.	Core	GA
az apim product show	Obtient les détails du produit spécifié par son identificateur.	Core	GA
az apim product update	Mettez à jour les détails du produit existant.	Core	GA
az apim product wait	Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un produit apim soit remplie.	Core	GA

az apim product create

Modifier

Crée un produit.

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Exemples

Crée un produit.

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

Paramètres obligatoires

--product-name

Nom du produit.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service de gestion des API.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--approval-required

Indique si l’approbation de l’abonnement est requise. Si la valeur est false, les nouveaux abonnements sont approuvés automatiquement pour permettre aux développeurs d’appeler les API du produit immédiatement après l’abonnement. Si la valeur est true, les administrateurs doivent approuver manuellement l’abonnement avant que le développeur puisse utiliser l’une des API du produit. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false.

Propriété	Valeur
Valeurs acceptées:	false, true

--description

Description du produit. Peut inclure des balises de mise en forme HTML.

--legal-terms

Conditions d’utilisation du produit. Les développeurs qui essaient de s’abonner au produit sont présentés et doivent accepter ces conditions avant de pouvoir terminer le processus d’abonnement.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété	Valeur
Valeur par défaut:	False

--product-id

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

--state

Indique si le produit est publié ou non. Les produits publiés sont détectables par les utilisateurs du portail des développeurs. Les produits non publiés ne sont visibles que par les administrateurs. L’état par défaut du produit n’est pas Publié. Les valeurs possibles sont les suivantes : « notPubliée », « publiée ».

Propriété	Valeur
Valeurs acceptées:	notPublished, published

--subscription-required -s

Indique si un abonnement produit est requis pour accéder aux API incluses dans ce produit.

Propriété	Valeur
Valeurs acceptées:	false, true

--subscriptions-limit

Indique si le nombre d’abonnements qu’un utilisateur peut avoir à ce produit en même temps. Définissez la valeur Null ou omettez pour autoriser un nombre illimité d’abonnements par utilisateur. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false.

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

az apim product delete

Modifier

Supprimez le produit.

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--yes]

Exemples

Supprimez le produit avec tous les abonnements à ce produit.

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

Paramètres obligatoires

--product-id

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service de gestion des API.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--delete-subscriptions

Supprimez les abonnements existants associés au produit ou non.

--if-match

ETag de l’entité.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété	Valeur
Valeur par défaut:	False

--yes -y

N’invitez pas à confirmer.

Propriété	Valeur
Valeur par défaut:	False

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

az apim product list

Modifier

Répertorie une collection de produits dans l’instance de service spécifiée.

az apim product list --resource-group
                     --service-name

Exemples

Répertoriez tous les produits pour cette instance APIM.

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

Paramètres obligatoires

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service de gestion des API.

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

az apim product show

Modifier

Obtient les détails du produit spécifié par son identificateur.

az apim product show --product-id
                     --resource-group
                     --service-name

Exemples

Obtient les détails du produit spécifié par son identificateur.

az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID

Paramètres obligatoires

--product-id

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service de gestion des API.

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

az apim product update

Modifier

Mettez à jour les détails du produit existant.

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Exemples

Mettez à jour les détails du produit existant.

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

Paramètres obligatoires

--product-id

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service de gestion des API.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

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

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments
Valeur par défaut:	[]

--approval-required

Propriété	Valeur
Valeurs acceptées:	false, true

--description

Description du produit. Peut inclure des balises de mise en forme HTML.

--force-string

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

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments
Valeur par défaut:	False

--if-match

ETag de l’entité.

--legal-terms

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Propriété	Valeur
Valeur par défaut:	False

--product-name

Nom du produit.

--remove

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

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments
Valeur par défaut:	[]

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

Propriété	Valeur
Groupe de paramètres:	Generic Update Arguments
Valeur par défaut:	[]

--state

Propriété	Valeur
Valeurs acceptées:	notPublished, published

--subscription-required -s

Indique si un abonnement produit est requis pour accéder aux API incluses dans ce produit.

Propriété	Valeur
Valeurs acceptées:	false, true

--subscriptions-limit

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

az apim product wait

Modifier

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’un produit apim soit remplie.

az apim product wait --product-id
                     --resource-group
                     --service-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

Exemples

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’apim soit remplie. (autogenerated)

az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

Paramètres obligatoires

--product-id

Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

--service-name -n

Nom de l’instance du service de gestion des API.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	False

--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments

--deleted

Attendez la suppression.

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	False

--exists

Attendez que la ressource existe.

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	False

--interval

Intervalle d’interrogation en secondes.

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	30

--timeout

Délai maximal d’attente en secondes.

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	3600

--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Propriété	Valeur
Groupe de paramètres:	Wait Condition Arguments
Valeur par défaut:	False

Paramètres globaux

--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété	Valeur
Valeur par défaut:	False

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété	Valeur
Valeur par défaut:	False

--output -o

Format de sortie.

Propriété	Valeur
Valeur par défaut:	json
Valeurs acceptées:	json, jsonc, none, table, tsv, yaml, yamlc

--query

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété	Valeur
Valeur par défaut:	False

Commentaires

Cette page a-t-elle été utile ?

Partager via

az apim product

Commandes

az apim product create

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apim product delete

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apim product list

Exemples

Paramètres obligatoires

az apim product show

Exemples

Paramètres obligatoires

az apim product update

Exemples

Paramètres obligatoires

Paramètres facultatifs

az apim product wait

Exemples

Paramètres obligatoires

Paramètres facultatifs

Commentaires