Partager via

Import-AzApiManagementApi

Module:
Az.ApiManagement Module

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

Syntaxe

ImportFromLocalFile (Par défaut) 

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

ImportFromUrl 

Import-AzApiManagementApi
    -Context <PsApiManagementContext>
    -SpecificationFormat <PsApiManagementApiFormat>
    -SpecificationUrl <String>
    [-ApiId <String>]
    [-ApiRevision <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 Gestion des API Azure à partir d’un fichier ou d’une URL dans le langage WADL (Web Application Description Language), WSDL (Web Services Description Language) ou le 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 aaaabbbb-0000-cccc-1111-dddd2222eeee -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/aaaabbbb-0000-cccc-1111-dddd2222eeee
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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants: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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants: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.

Propriétés du paramètre

Type:

Nullable<T>[PsApiManagementApiType]

Valeur par défaut:None
Valeurs acceptées:Http, Soap, WebSocket, GraphQL
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ApiVersion

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

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ApiVersionSetId

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

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Context

Spécifie un objet PsApiManagementContext .

Propriétés du paramètre

Type:PsApiManagementContext
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-DefaultProfile

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

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants: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.

Propriétés du paramètre

Type:

PsApiManagementSchema[]

Valeur par défaut:None
Valeurs acceptées:Http, Https, Ws, Wss
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ServiceUrl

URL du service web exposant l’API. Cette URL sera utilisée uniquement par Gestion des API Azure 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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-SpecificationFormat

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

Propriétés du paramètre

Type:PsApiManagementApiFormat
Valeur par défaut:None
Valeurs acceptées:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-SpecificationPath

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

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ImportFromLocalFile
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-SpecificationUrl

Spécifie l’URL de spécification.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ImportFromUrl
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants: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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants: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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

PsApiManagementContext

String

PsApiManagementApiFormat

Nullable<T>

Sorties

PsApiManagementApi