Import-AzApiManagementApi

Référence

Module:: Az.ApiManagement

Importe une API à partir d’un fichier ou d’une URL.

Syntaxe

Import-AzApiManagementApi
      -Context <PsApiManagementContext>
      [-ApiId <String>]
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      -SpecificationPath <String>
      [-Path <String>]
      [-WsdlServiceName <String>]
      [-WsdlEndpointName <String>]
      [-ApiType <PsApiManagementApiType>]
      [-Protocol <PsApiManagementSchema[]>]
      [-ServiceUrl <String>]
      [-ApiVersionSetId <String>]
      [-ApiVersion <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Import-AzApiManagementApi
      -Context <PsApiManagementContext>
      [-ApiId <String>]
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      -SpecificationUrl <String>
      [-Path <String>]
      [-WsdlServiceName <String>]
      [-WsdlEndpointName <String>]
      [-ApiType <PsApiManagementApiType>]
      [-Protocol <PsApiManagementSchema[]>]
      [-ServiceUrl <String>]
      [-ApiVersionSetId <String>]
      [-ApiVersion <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

L’applet de commande Import-AzApiManagementApi importe une API Azure Gestion des API à partir d’un fichier ou d’une URL dans waDL (Web Application Description Language), WSDL (Web Services Description Language) ou au format Swagger.

Exemples

Exemple 1 : Importer une API à partir d’un fichier WADL

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationPath "C:\contoso\specifications\echoapi.wadl" -Path "apis"

Cette commande importe une API à partir du fichier WADL spécifié.

Exemple 2 : Importer une API à partir d’un fichier Swagger

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis"

Cette commande importe une API à partir du fichier Swagger spécifié.

Exemple 3 : Importer une API à partir d’un fichier Swagger et mettre à jour une API existante

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -ApiId "26591405e27d4ff3a8d8478d7e60c7b0" -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis"

Cette commande importe une API à partir du fichier Swagger spécifié et met à jour une API existante.

Exemple 4 : Importer une API à partir d’un lien WADL

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationUrl "http://contoso.com/specifications/wadl/echoapi" -Path "apis"

Cette commande importe une API à partir du lien WADL spécifié.

Exemple 5 : Importer une API à partir d’un lien Open API

$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $context -SpecificationFormat OpenApi -SpecificationUrl https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml -Path "petstore30"

ApiId                         : af3f57bab399455aa875d7050654e9d1
Name                          : Swagger Petstore
Description                   :
ServiceUrl                    : http://petstore.swagger.io/v1
Path                          : petstore30
ApiType                       : http
Protocols                     : {Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    :
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          :
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               :
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/af3f57bab399455aa875d7050654e9d1     
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

Cette commande importe une API à partir du lien de spécification Open 3.0 spécifié.

Exemple 6 : Importer une API à partir d’un lien Open API dans un jeu ApiVersion

$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $context -SpecificationPath "C:\contoso\specifications\uspto.yml" -SpecificationFormat OpenApi -Path uspostal -ApiVersionSetId 0d50e2cf-aaeb-4ea3-8a58-db9ec079c6cd -ApiVersion v2

ApiId                         : 6c3f20c66e5745b19229d06cd865948f
Name                          : USPTO Data Set API
Description                   : The Data Set API (DSAPI) allows the public users to discover and search USPTO exported data sets. This is a generic API that allows USPTO users to make any CSV based data files
                                searchable through API. With the help of GET call, it returns the list of data fields that are searchable. With the help of POST call, data can be fetched based on the filters on the    
                                field names. Please note that POST call is used to search the actual data. The reason for the POST call is that it allows users to specify any complex search criteria without worry      
                                about the GET size limitations as well as encoding of the input parameters.
ServiceUrl                    : https://developer.uspto.gov/ds-api
Path                          : uspostal
ApiType                       : http
Protocols                     : {Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    : v2
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          :
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/0d50e2cf-aaeb-4ea3-8a58-db9ec079c6cd
Id                            : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/apis/6c3f20c66e5745b19229d06cd865948f    
ResourceGroupName             : Api-Default-East-US
ServiceName                   : contoso

Cette commande importe une API à partir du document de spécification Open 3.0 spécifié et crée une apiVersion.

Exemple 7 : Importer une API à partir d’un lien GraphQL

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "GraphQL" -SpecificationUrl "http://contoso.com/graphql" -Path "graphqlapi"

ApiId                         : bg4g23csd067432zz853f0942341g3z1
Name                          : GraphQL Api
Description                   :
ServiceUrl                    : http://contoso.com/graphql
Path                          : graphqlapi
ApiType                       : graphql
Protocols                     : {Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    :
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          :
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               :
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/bg4g23csd067432zz853f0942341g3z1     
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

Cette commande importe une API à partir du lien GraphQL.

Paramètres

-ApiId

Spécifie un ID pour l’API à importer. Si vous ne spécifiez pas ce paramètre, un ID est généré pour vous.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ApiRevision

Identificateur de révision de l’API. Ce paramètre est facultatif. Si elle n’est pas spécifiée, l’importation est effectuée sur la révision active ou sur une nouvelle API.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ApiType

Ce paramètre est facultatif avec une valeur par défaut de Http. L’option Soap s’applique uniquement lors de l’importation de WSDL et crée une API passthrough SOAP.

Type:	Nullable<T>[PsApiManagementApiType]
Valeurs acceptées:	Http, Soap, WebSocket, GraphQL
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ApiVersion

Version d’API de l’API à créer. Ce paramètre est facultatif.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ApiVersionSetId

Identificateur de ressource pour le jeu de versions d’API associé. Ce paramètre est facultatif.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Context

Spécifie un objet PsApiManagementContext .

Type:	PsApiManagementContext
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	False
Accepter les caractères génériques:	False

-Path

Spécifie un chemin d’accès d’API web comme dernière partie de l’URL publique de l’API. Cette URL est utilisée par les consommateurs d’API pour envoyer des requêtes au service web. Doit avoir une longueur de 1 à 400 caractères. La valeur par défaut est $Null.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Protocol

Protocoles d’API web (http, https). Protocoles sur lesquels l’API est rendue disponible. Ce paramètre est facultatif. S’il est fourni, il remplace les protocoles spécifiés dans le document des spécifications.

Type:	PsApiManagementSchema[]
Valeurs acceptées:	Http, Https, Ws, Wss
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ServiceUrl

URL du service web exposant l’API. Cette URL sera utilisée par Azure Gestion des API uniquement et ne sera pas rendue publique. Ce paramètre est facultatif. S’il est fourni, il remplace le ServiceUrl spécifié dans le document Spécifications.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-SpecificationFormat

Spécifie le format de spécification. psdx_paramvalues Wadl, Wsdl et Swagger.

Type:	PsApiManagementApiFormat
Valeurs acceptées:	Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-SpecificationPath

Spécifie le chemin du fichier de spécification.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-SpecificationUrl

Spécifie l’URL de spécification.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-WsdlEndpointName

Nom local du point de terminaison WSDL (port) à importer. Doit avoir une longueur de 1 à 400 caractères. Ce paramètre est facultatif et uniquement requis pour l’importation de Wsdl. La valeur par défaut est $null.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-WsdlServiceName

Nom local du service WSDL à importer. Doit avoir une longueur de 1 à 400 caractères. Ce paramètre est facultatif et uniquement requis pour l’importation de Wsdl. La valeur par défaut est $null.

Type:	String
Position:	Named
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

Entrées

PsApiManagementContext

String

PsApiManagementApiFormat

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Sorties

PsApiManagementApi

Partager via

Import-AzApiManagementApi

Syntaxe

Description

Exemples

Exemple 1 : Importer une API à partir d’un fichier WADL

Exemple 2 : Importer une API à partir d’un fichier Swagger

Exemple 3 : Importer une API à partir d’un fichier Swagger et mettre à jour une API existante

Exemple 4 : Importer une API à partir d’un lien WADL

Exemple 5 : Importer une API à partir d’un lien Open API

Exemple 6 : Importer une API à partir d’un lien Open API dans un jeu ApiVersion

Exemple 7 : Importer une API à partir d’un lien GraphQL

Paramètres

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Entrées

Sorties

Ressources supplémentaires

Partager via

Import-AzApiManagementApi

Syntaxe

Description

Exemples

Exemple 1 : Importer une API à partir d’un fichier WADL

Exemple 2 : Importer une API à partir d’un fichier Swagger

Exemple 3 : Importer une API à partir d’un fichier Swagger et mettre à jour une API existante

Exemple 4 : Importer une API à partir d’un lien WADL

Exemple 5 : Importer une API à partir d’un lien Open API

Exemple 6 : Importer une API à partir d’un lien Open API dans un jeu ApiVersion

Exemple 7 : Importer une API à partir d’un lien GraphQL

Paramètres

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Entrées

Sorties

Liens associés

Ressources supplémentaires