Set-AzApiManagementApiRevision
Modyfikuje poprawkę interfejsu API
Składnia
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>] Opis
Polecenie cmdlet Set-AzApiManagementApiRevision modyfikuje poprawkę interfejsu API usługi Azure API Management.
Przykłady
Przykład 1. Modyfikowanie poprawki interfejsu 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"Polecenie cmdlet aktualizuje 2 poprawkę interfejsu API echo-api przy użyciu nowego opisu, protokołu i ścieżki.
Parametry
-ApiId
Identyfikator istniejącego interfejsu API. Ten parametr jest wymagany.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-ApiRevision
Identyfikator istniejącej poprawki interfejsu API. Ten parametr jest wymagany.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-AuthorizationScope
Zakres operacji OAuth. Ten parametr jest opcjonalny. Wartość domyślna to $null.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-AuthorizationServerId
Identyfikator serwera autoryzacji OAuth. Ten parametr jest opcjonalny. Wartość domyślna to $null. Należy określić, jeśli określono parametr AuthorizationScope.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-BearerTokenSendingMethod
Mechanizm serwera autoryzacji OpenId, za pomocą którego token dostępu jest przekazywany do interfejsu API. Zapoznaj się z https://datatracker.ietf.org/doc/html/rfc6749#section-4. Ten parametr jest opcjonalny. Wartość domyślna to $null.
| Typ: | String[] |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-Confirm
Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.
| Typ: | SwitchParameter |
| Aliasy: | cf |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | False |
| Akceptowanie symboli wieloznacznych: | False |
-Context
Wystąpienie elementu PsApiManagementContext. Ten parametr jest wymagany.
| Typ: | PsApiManagementContext |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-DefaultProfile
Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.
| Typ: | IAzureContextContainer |
| Aliasy: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | False |
| Akceptowanie symboli wieloznacznych: | False |
-Description
Opis internetowego interfejsu API. Ten parametr jest opcjonalny.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-InputObject
Wystąpienie psApiManagementApi. Ten parametr jest wymagany.
| Typ: | PsApiManagementApi |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | True |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-Name
Nazwa internetowego interfejsu API. Publiczna nazwa interfejsu API wyświetlana w portalach deweloperskich i administracyjnych. Ten parametr jest wymagany.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-OpenIdProviderId
Identyfikator serwera autoryzacji OpenId. Ten parametr jest opcjonalny. Wartość domyślna to $null. Należy określić, jeśli określono element BearerTokenSendingMethods.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-PassThru
Jeśli określono wystąpienie klasy Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi, reprezentujące ustawiony interfejs API.
| Typ: | SwitchParameter |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-Path
Ścieżka internetowego interfejsu API. Ostatnia część publicznego adresu URL interfejsu API. Ten adres URL będzie używany przez użytkowników interfejsu API do wysyłania żądań do usługi internetowej. Musi mieć długość od 1 do 400 znaków. Ten parametr jest opcjonalny. Wartość domyślna to $null.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-Protocols
Protokoły internetowego interfejsu API (http, https). Protokoły, za pośrednictwem których udostępniono interfejs API. Ten parametr jest wymagany. Wartość domyślna to $null.
| Typ: | PsApiManagementSchema[] |
| Dopuszczalne wartości: | Http, Https |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-ServiceUrl
Adres URL usługi internetowej uwidaczniającej interfejs API. Ten adres URL będzie używany tylko przez usługę Azure API Management i nie zostanie upubliczniony. Musi mieć długość od 1 do 2000 znaków. Ten parametr jest wymagany.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-SubscriptionKeyHeaderName
Nazwa nagłówka klucza subskrypcji. Ten parametr jest opcjonalny. Wartość domyślna to $null.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-SubscriptionKeyQueryParamName
Nazwa parametru ciągu zapytania klucza subskrypcji. Ten parametr jest opcjonalny. Wartość domyślna to $null.
| Typ: | String |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-SubscriptionRequired
Flaga wymuszania subskrypcjiWymagane dla żądań do interfejsu API. Ten parametr jest opcjonalny.
| Typ: | SwitchParameter |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | True |
| Akceptowanie symboli wieloznacznych: | False |
-WhatIf
Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie jest uruchamiane.
| Typ: | SwitchParameter |
| Aliasy: | wi |
| Position: | Named |
| Domyślna wartość: | None |
| Wymagane: | False |
| Akceptowanie danych wejściowych potoku: | False |
| Akceptowanie symboli wieloznacznych: | False |
