Поделиться через

New-AzApiManagementApi

  • Ссылка
Модуль:
Az.ApiManagement

Создает API.

Синтаксис

New-AzApiManagementApi
   -Context <PsApiManagementContext>
   [-ApiId <String>]
   -Name <String>
   [-Description <String>]
   -ServiceUrl <String>
   -Path <String>
   -Protocols <PsApiManagementSchema[]>
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-ProductIds <String[]>]
   [-SubscriptionRequired]
   [-ApiVersionDescription <String>]
   [-ApiVersionSetId <String>]
   [-ApiVersion <String>]
   [-SourceApiId <String>]
   [-SourceApiRevision <String>]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Описание

Командлет New-AzApiManagementApi создает API управления API Azure.

Примеры

Пример 1. Создание API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi"

Эта команда создает API с именем EchoApi с указанным URL-адресом.

Пример 2. Создание API путем копирования всех операций, тегов, продуктов и политик из эхо-API и в ApiVersionSet

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso
$versionSet = Get-AzApiManagementApiVersionSet -Context $context -ApiVersionSetId "xmsVersionSet"
New-AzApiManagementApi -Context $context -Name "echoapiv4" -Description "Create Echo Api V4" -SubscriptionRequired -ServiceUrl "https://echoapi.cloudapp.net/v4" -Path "echov3" -Protocols @("http", "https") -ApiVersionSetId $versionSet.ApiVersionSetId -SourceApiId "echo-api" -ApiVersion "v4"

ApiId                         : 691b7d410125414a929c108541c60e06
Name                          : echoapiv4
Description                   : Create Echo Api V4
ServiceUrl                    : https://echoapi.cloudapp.net/v4
Path                          : echov3
ApiType                       : http
Protocols                     : {Http, Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    : v4
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          : True
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/xmsVersionSet
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/691b7d410125414a929c108541c60e06
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

Эта команда создает echoapiv3 API в ApiVersionSet xmsVersionSet и копирует все операции, теги и политики из исходного api echo-api. Он переопределяет subscriptionRequired, ServiceUrl, Path, Protocols

Пример 3

Создает API. (автоматическое создание)

New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'

Параметры

-ApiId

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

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ApiType

Тип API для создания (http, soap, websocket, graphql). Этот параметр является необязательным.

Тип:Nullable<T>[PsApiManagementApiType]
Допустимые значения:Http, Soap, WebSocket, GraphQL
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ApiVersion

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

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ApiVersionDescription

Описание версии API. Этот параметр является необязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ApiVersionSetId

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

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-AuthorizationScope

Указывает область операций OAuth. Значение по умолчанию — $Null.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-AuthorizationServerId

Указывает идентификатор сервера авторизации OAuth. Значение по умолчанию — $Null. Этот параметр необходимо указать, если указан AuthorizationScope.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-BearerTokenSendingMethod

Механизм сервера авторизации OpenId, с помощью которого маркер доступа передается API. См. https://datatracker.ietf.org/doc/html/rfc6749#section-4. Этот параметр является необязательным. Значение по умолчанию — $null.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ContactEmail

Адрес электронной почты контактного лица или организации. Должен быть в формате адреса электронной почты. Этот параметр является необязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ContactName

Имя контактного лица или организации. Этот параметр является необязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ContactUrl

URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса. Этот параметр является необязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Context

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

Тип:PsApiManagementContext
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-DefaultProfile

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

Тип:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Description

Указывает описание веб-API.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-LicenseName

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

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-LicenseUrl

URL-адрес условий обслуживания для API. Этот параметр является необязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Name

Указывает имя веб-API. Это общедоступное имя API, как оно отображается на порталах разработчика и администрирования.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-OpenIdProviderId

Идентификатор сервера авторизации OpenId. Этот параметр является необязательным. Значение по умолчанию — $null. Необходимо указать, указан ли bearerTokenSendingMethods.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Path

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

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ProductIds

Задает массив идентификаторов продуктов, к которым необходимо добавить новый API.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Protocols

Задает массив протоколов веб-API. Допустимые значения: http, https. Это веб-протоколы, через которые предоставляется API. Значение по умолчанию — $Null.

Тип:PsApiManagementSchema[]
Допустимые значения:Http, Https, Ws, Wss
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ServiceUrl

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

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-SourceApiId

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

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-SourceApiRevision

Редакция API исходного API. Этот параметр является необязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-SubscriptionKeyHeaderName

Указывает имя заголовка ключа подписки. Значение по умолчанию — $Null.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-SubscriptionKeyQueryParamName

Указывает имя параметра строки запроса ключа подписки. Значение по умолчанию — $Null.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-SubscriptionRequired

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-TermsOfServiceUrl

URL-адрес условий обслуживания для API. Этот параметр является необязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

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

PsApiManagementContext

String

PsApiManagementSchema[]

String[]

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

PsApiManagementApi