Set-AzApiManagementApi

Модуль:

Az.ApiManagement

Изменяет API.

Синтаксис

Set-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>]
   [-SubscriptionRequired]
   [-PassThru]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Set-AzApiManagementApi
   -InputObject <PsApiManagementApi>
   [-Name <String>]
   [-Description <String>]
   [-ServiceUrl <String>]
   [-Path <String>]
   [-Protocols <PsApiManagementSchema[]>]
   [-AuthorizationServerId <String>]
   [-AuthorizationScope <String>]
   [-OpenIdProviderId <String>]
   [-BearerTokenSendingMethod <String[]>]
   [-SubscriptionKeyHeaderName <String>]
   [-SubscriptionKeyQueryParamName <String>]
   [-SubscriptionRequired]
   [-PassThru]
   [-ApiType <PsApiManagementApiType>]
   [-TermsOfServiceUrl <String>]
   [-ContactName <String>]
   [-ContactUrl <String>]
   [-ContactEmail <String>]
   [-LicenseName <String>]
   [-LicenseUrl <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Описание

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

Примеры

Пример 1. Изменение API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"

Пример 2. Добавление API в существующий ApiVersionSet

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$versionSet = New-AzApiManagementApiVersionSet -Context $context -Name "Echo API Version Set" -Scheme Segment -Description "version set sample"
$api = Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId "echo-api"
$api.ApiVersionSetId = $versionSet.Id
$api.ApiVersion = "v1"
$api.ApiVersionSetDescription = $versionSet.Description
Set-AzApiManagementApi -InputObject $api -PassThru

Этот пример добавляет API в существующий набор версий API

Пример 3. Изменение серверной службыUrl, на который указывает API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$updatedApiServiceUrl = "http://newechoapi.cloudapp.net/updateapi"
$updatedApi = Set-AzApiManagementApi -Context $ApiMgmtContext -ApiId $echoApiId -ServiceUrl $updatedApiServiceUrl

В этом примере обновляется ServiceUrl, на который указывает echo-api.

Параметры

-ApiId

Указывает идентификатор API для изменения.

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

-ApiType

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

Тип:	Nullable<T>[PsApiManagementApiType]
Допустимые значения:	Http, Soap, WebSocket, GraphQL
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

-InputObject

Экземпляр PsApiManagementApi. Этот параметр является обязательным.

Тип:	PsApiManagementApi
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	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.

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

-OpenIdProviderId

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

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

-PassThru

passthru

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

-Path

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

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

-Protocols

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

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

-ServiceUrl

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

Тип:	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

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

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

PsApiManagementApi

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

• Export-AzApiManagementApi
• Get-AzApiManagementApi
• Import-AzApiManagementApi
• New-AzApiManagementApi
• Remove-AzApiManagementApi