Import-AzApiManagementApi

Ссылка

Модуль:: Az.ApiManagement

Импортирует API из файла или URL-адреса.

Синтаксис

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

Описание

Командлет Import-AzApiManagementApi импортирует API Управление API Azure из файла или URL-адреса в языке описания веб-приложения (WADL), языке описания веб-служб (WSDL) или формате Swagger.

Примеры

Пример 1. Импорт API из WADL-файла

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

Эта команда импортирует API из указанного WADL-файла.

Пример 2. Импорт API из файла Swagger

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

Эта команда импортирует API из указанного файла Swagger.

Пример 3. Импорт API из файла Swagger и обновление существующего API

$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"

Эта команда импортирует API из указанного файла Swagger и обновляет существующий API.

Пример 4. Импорт API из ссылки 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"

Эта команда импортирует API из указанной ссылки WADL.

Пример 5. Импорт API из открытого канала 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

Эта команда импортирует API из указанной ссылки спецификации Open 3.0.

Пример 6. Импорт API из открытого канала API в набор 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

Эта команда импортирует API из указанного документа спецификации Open 3.0 и создает новый ApiVersion.

Пример 7. Импорт API из ссылки 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

Эта команда импортирует API из ссылки GraphQL.

Параметры

-ApiId

Указывает идентификатор импорта API. Если этот параметр не указан, создается идентификатор.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ApiRevision

Идентификатор редакции API. Это необязательный параметр. Если этот параметр не указан, импорт будет выполнен в активной редакции или новом API.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ApiType

Этот параметр необязателен со значением http по умолчанию. Параметр Soap применим только при импорте WSDL и создаст API сквозного руководства SOAP.

Type:	Nullable<T>[PsApiManagementApiType]
Accepted values:	Http, Soap, WebSocket, GraphQL
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ApiVersion

Версия API для создания. Это необязательный параметр.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ApiVersionSetId

Идентификатор ресурса для связанного набора версий API. Это необязательный параметр.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Context

Указывает объект PsApiManagementContext .

Type:	PsApiManagementContext
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Указывает путь веб-API в качестве последней части общедоступного URL-адреса API. Этот URL-адрес используется потребителями API для отправки запросов в веб-службу. Должно содержать от 1 до 400 символов. Значение по умолчанию — $Null.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Protocol

Протоколы веб-API (http, https). Протоколы, через которые предоставляется API. Это необязательный параметр. Если он указан, переопределит протоколы, указанные в документе спецификаций.

Type:	PsApiManagementSchema[]
Accepted values:	Http, Https, Ws, Wss
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ServiceUrl

URL-адрес веб-службы, предоставляющей API. Этот URL-адрес будет использоваться только в Azure Управление API и не будет общедоступным. Это необязательный параметр. Если он указан, он переопределит ServiceUrl, указанный в документе спецификаций.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SpecificationFormat

Задает формат спецификации. psdx_paramvalues Wadl, Wsdl и Swagger.

Type:	PsApiManagementApiFormat
Accepted values:	Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SpecificationPath

Указывает путь к файлу спецификации.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SpecificationUrl

Указывает URL-адрес спецификации.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WsdlEndpointName

Локальное имя конечной точки WSDL (порт), импортируемое. Должно содержать от 1 до 400 символов. Этот параметр является необязательным и требуется только для импорта Wsdl. Значение по умолчанию — $null.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-WsdlServiceName

Имя локальной службы WSDL, импортируемой. Должно содержать от 1 до 400 символов. Этот параметр является необязательным и требуется только для импорта Wsdl. Значение по умолчанию — $null.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Входные данные

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

Выходные данные

PsApiManagementApi

Import-AzApiManagementApi

Синтаксис

Описание

Примеры

Пример 1. Импорт API из WADL-файла

Пример 2. Импорт API из файла Swagger

Пример 3. Импорт API из файла Swagger и обновление существующего API

Пример 4. Импорт API из ссылки WADL

Пример 5. Импорт API из открытого канала API

Пример 6. Импорт API из открытого канала API в набор ApiVersion

Пример 7. Импорт API из ссылки GraphQL

Параметры

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Входные данные

Выходные данные

Обратная связь

Дополнительные ресурсы

Import-AzApiManagementApi

Синтаксис

Описание

Примеры

Пример 1. Импорт API из WADL-файла

Пример 2. Импорт API из файла Swagger

Пример 3. Импорт API из файла Swagger и обновление существующего API

Пример 4. Импорт API из ссылки WADL

Пример 5. Импорт API из открытого канала API

Пример 6. Импорт API из открытого канала API в набор ApiVersion

Пример 7. Импорт API из ссылки GraphQL

Параметры

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Входные данные

Выходные данные

Связанные ссылки

Обратная связь

Дополнительные ресурсы