Set-AzApiManagementApiRevision
Изменяет редакцию 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. Этот параметр является обязательным.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApiRevision
Идентификатор существующей редакции API. Этот параметр является обязательным.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationScope
Операции OAuth область. Это необязательный параметр. Значение по умолчанию — $null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationServerId
Идентификатор сервера авторизации OAuth. Это необязательный параметр. Значение по умолчанию — $null. Необходимо указать, задано ли AuthorizationScope.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BearerTokenSendingMethod
Механизм сервера авторизации OpenId, с помощью которого маркер доступа передается API. См. https://datatracker.ietf.org/doc/html/rfc6749#section-4. Это необязательный параметр. Значение по умолчанию — $null.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Запрос подтверждения перед выполнением командлета.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-Description
Описание веб-API. Это необязательный параметр.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Экземпляр PsApiManagementApi. Этот параметр является обязательным.
| Type: | PsApiManagementApi |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Имя веб-API. Общедоступное имя API, как оно будет отображаться на порталах разработчика и администрирования. Этот параметр является обязательным.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OpenIdProviderId
Идентификатор сервера авторизации OpenId. Это необязательный параметр. Значение по умолчанию — $null. Необходимо указать, указан ли bearerTokenSendingMethods.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Если указан экземпляр Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi, представляющий набор API.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
-Protocols
Протоколы веб-API (http, https). Протоколы, через которые предоставляется API. Этот параметр является обязательным. Значение по умолчанию — $null.
| Type: | PsApiManagementSchema[] |
| Accepted values: | Http, Https |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceUrl
URL-адрес веб-службы, предоставляющей API. Этот URL-адрес будет использоваться только в Azure Управление API и не будет общедоступным. Должно содержать от 1 до 2000 символов. Этот параметр является обязательным.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionKeyHeaderName
Имя заголовка ключа подписки. Это необязательный параметр. Значение по умолчанию — $null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionKeyQueryParamName
Имя параметра строки запроса ключа подписки. Это необязательный параметр. Значение по умолчанию — $null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionRequired
Пометка для принудительного применения subscriptionRequired для запросов к API. Это необязательный параметр.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |