Set-AzApiManagementApiRevision
Ändert eine API-Revision
Syntax
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>] Beschreibung
Das Cmdlet Set-AzApiManagementApiRevision ändert eine Revision der Azure API-Verwaltungs-API.
Beispiele
Beispiel 1: Ändern einer API-Revision
$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"Das Cmdlet aktualisiert die 2 Revision der API echo-api mit einer neuen Beschreibung, einem neuen Protokoll und Pfad.
Parameter
-ApiId
Bezeichner vorhandener API. Dieser Parameter ist erforderlich.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-ApiRevision
Bezeichner der vorhandenen API-Revision. Dieser Parameter ist erforderlich.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-AuthorizationScope
OAuth-Operationsbereich. Dieser Parameter ist optional. Der Standardwert ist $null.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-AuthorizationServerId
OAuth-Autorisierungsserverbezeichner. Dieser Parameter ist optional. Der Standardwert ist $null. Muss angegeben werden, wenn AuthorizationScope angegeben ist.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-BearerTokenSendingMethod
OpenId-Autorisierungsservermechanismus, mit dem Zugriffstoken an die API übergeben wird. Lesen Sie https://datatracker.ietf.org/doc/html/rfc6749#section-4. Dieser Parameter ist optional. Der Standardwert ist $null.
| Typ: | String[] |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Confirm
Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.
| Typ: | SwitchParameter |
| Aliase: | cf |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-Context
Instanz von PsApiManagementContext. Dieser Parameter ist erforderlich.
| Typ: | PsApiManagementContext |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-DefaultProfile
Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure
| Typ: | IAzureContextContainer |
| Aliase: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |
-Description
Web-API-Beschreibung. Dieser Parameter ist optional.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-InputObject
Instanz von PsApiManagementApi. Dieser Parameter ist erforderlich.
| Typ: | PsApiManagementApi |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | True |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Name
Web-API-Name. Öffentlicher Name der API, wie sie auf den Entwickler- und Administratorportalen angezeigt wird. Dieser Parameter ist erforderlich.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-OpenIdProviderId
OpenId-Autorisierungsserverbezeichner. Dieser Parameter ist optional. Der Standardwert ist $null. Muss angegeben werden, wenn BearerTokenSendingMethods angegeben ist.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-PassThru
Wenn angegeben, wird die Instanz von Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi-Typ, der die Set-API darstellt.
| Typ: | SwitchParameter |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Path
Web-API-Pfad. Letzter Teil der öffentlichen URL der API. Diese URL wird von API-Consumern zum Senden von Anforderungen an den Webdienst verwendet. Muss 1 bis 400 Zeichen lang sein. Dieser Parameter ist optional. Der Standardwert ist $null.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-Protocols
Web-API-Protokolle (http, https). Protokolle, über die API verfügbar gemacht wird. Dieser Parameter ist erforderlich. Der Standardwert ist $null.
| Typ: | PsApiManagementSchema[] |
| Zulässige Werte: | Http, Https |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-ServiceUrl
Eine URL des Webdiensts, der die API verfügbar gibt. Diese URL wird nur von Azure API Management verwendet und wird nicht öffentlich gemacht. Muss 1 bis 2000 Zeichen lang sein. Dieser Parameter ist erforderlich.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-SubscriptionKeyHeaderName
Name des Abonnementschlüsselheaders. Dieser Parameter ist optional. Der Standardwert ist $null.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-SubscriptionKeyQueryParamName
Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage. Dieser Parameter ist optional. Der Standardwert ist $null.
| Typ: | String |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-SubscriptionRequired
Flag zum Erzwingen von SubscriptionRequired für Anforderungen an die API. Dieser Parameter ist optional.
| Typ: | SwitchParameter |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | True |
| Platzhalterzeichen akzeptieren: | False |
-WhatIf
Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
| Typ: | SwitchParameter |
| Aliase: | wi |
| Position: | Named |
| Standardwert: | None |
| Erforderlich: | False |
| Pipelineeingabe akzeptieren: | False |
| Platzhalterzeichen akzeptieren: | False |