Partager via


az apic integration create

Note

Cette référence fait partie de l’extension apic-extension pour Azure CLI (version 2.57.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az apic integration create commande. Apprenez-en davantage sur les extensions.

Commandes

Nom Description Type État
az apic integration create apim

Ajoutez Azure APIM en tant que source d’API.

Extension Assemblée générale
az apic integration create aws

Ajoutez Amazon API Gateway en tant que source d’API.

Extension Assemblée générale

az apic integration create apim

Ajoutez Azure APIM en tant que source d’API.

az apic integration create apim --azure-apim
                                --integration-name
                                --resource-group
                                --service-name
                                [--import-specification {always, never, ondemand}]
                                [--msi-resource-id]
                                [--target-environment-id]
                                [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Exemples

Ajouter Azure APIM dans le même groupe de ressources que l’instance du Centre d’API Azure en tant que source d’API

az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim myapim

Ajouter Azure APIM dans un autre groupe de ressources en tant que source d’API

az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim /subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/samplegroup/providers/Microsoft.ApiManagement/service/sampleapim

Paramètres obligatoires

--azure-apim

Nom ou ID de ressource de l’instance APIM source.

Propriété Valeur
Groupe de paramètres: AzureApiManagementSource Arguments
--integration-name -i

Nom de l’intégration.

--resource-group -g

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

--service-name -n

Nom du service Du Centre des API Azure.

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.

--import-specification

Indique si la spécification doit être importée avec les métadonnées.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeur par défaut: always
Valeurs acceptées: always, never, ondemand
--msi-resource-id

ID de ressource de l’identité managée qui a accès à l’instance Gestion des API.

Propriété Valeur
Groupe de paramètres: AzureApiManagementSource Arguments
--target-environment-id

ID de ressource de l’environnement cible.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--target-lifecycle-stage

Étape de cycle de vie cible.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: deprecated, design, development, preview, production, retired, testing
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 apic integration create aws

Ajoutez Amazon API Gateway en tant que source d’API.

az apic integration create aws --aws-access-key-reference
                               --aws-region-name
                               --aws-secret-access-key-reference
                               --integration-name
                               --resource-group
                               --service-name
                               [--import-specification {always, never, ondemand}]
                               [--msi-resource-id]
                               [--target-environment-id]
                               [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Exemples

Ajouter Amazon API Gateway en tant que source d’API

az apic integration create aws -g contoso-resources -n contoso -i sync-from-my-amazon-api-gateway -a https://{keyvaultName}.vault.azure.net/secrets/{secretName1} -s https://{keyvaultName}.vault.azure.net/secrets/{secretName2} -r us-east-2

Paramètres obligatoires

--aws-access-key-reference -a

Clé d’accès à la passerelle API Amazon. Doit être une référence de secret Azure Key Vault.

Propriété Valeur
Groupe de paramètres: AmazonApiGatewaySource Arguments
--aws-region-name -r

Région de la passerelle API Amazon (par exemple, us-east-2).

Propriété Valeur
Groupe de paramètres: AmazonApiGatewaySource Arguments
--aws-secret-access-key-reference -s

Clé d’accès au secret de la passerelle API Amazon. Doit être une référence de secret Azure Key Vault.

Propriété Valeur
Groupe de paramètres: AmazonApiGatewaySource Arguments
--integration-name -i

Nom de l’intégration.

--resource-group -g

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

--service-name -n

Nom du service Du Centre des API Azure.

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.

--import-specification

Indique si la spécification doit être importée avec les métadonnées.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeur par défaut: always
Valeurs acceptées: always, never, ondemand
--msi-resource-id

ID de ressource de l’identité managée qui a accès à Azure Key Vault.

Propriété Valeur
Groupe de paramètres: AmazonApiGatewaySource Arguments
--target-environment-id

ID de ressource de l’environnement cible.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--target-lifecycle-stage

Étape de cycle de vie cible.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: deprecated, design, development, preview, production, retired, testing
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