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

Set-AzApiManagementApiRevision

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

Изменяет редакцию API

Синтаксис

Set-AzApiManagementApiRevision
   -ApiRevision <String>
   -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]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementApiRevision
   -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]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

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

Примеры

Пример 1. Изменение редакции API

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

Командлет обновляет 2 редакцию API echo-api с новым описанием, протоколом и путем.

Параметры

-ApiId

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

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

-ApiRevision

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

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

-Confirm

Запрашивает подтверждение перед запуском командлета.

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

-Name

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

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

-OpenIdProviderId

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

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

-PassThru

Если указан экземпляр Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi, представляющий набор API.

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

-Path

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

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

-Protocols

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

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

-ServiceUrl

URL-адрес веб-службы, предоставляющей API. Этот URL-адрес будет использоваться только службой управления API Azure и не будет общедоступным. Должно содержать от 1 до 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

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

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

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

String

PsApiManagementContext

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

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

PsApiManagementApi