Delen via

Set-AzApiManagementApiRevision

  • Referentie
Module:
Az.ApiManagement

Hiermee wijzigt u een API-revisie

Syntaxis

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>]

Description

De cmdlet Set-AzApiManagementApiRevision wijzigt een Azure API Management API-revisie.

Voorbeelden

Voorbeeld 1: Een API-revisie wijzigen

$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"

De cmdlet werkt de 2 revisie van de API echo-api bij met een nieuwe beschrijving, protocol en pad.

Parameters

-ApiId

Id van bestaande API. Deze parameter is vereist.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-ApiRevision

Id van bestaande API-revisie. Deze parameter is vereist.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-AuthorizationScope

OAuth-bewerkingsbereik. Deze parameter is optioneel. De standaardwaarde is $null.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-AuthorizationServerId

OAuth-autorisatieserver-id. Deze parameter is optioneel. De standaardwaarde is $null. Moet worden opgegeven als AuthorizationScope is opgegeven.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-BearerTokenSendingMethod

OpenId-autorisatieservermechanisme waarmee het toegangstoken wordt doorgegeven aan de API. https://datatracker.ietf.org/doc/html/rfc6749#section-4Raadpleeg . Deze parameter is optioneel. De standaardwaarde is $null.

Type:String[]
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Context

Exemplaar van PsApiManagementContext. Deze parameter is vereist.

Type:PsApiManagementContext
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Description

Beschrijving van web-API. Deze parameter is optioneel.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-InputObject

Exemplaar van PsApiManagementApi. Deze parameter is vereist.

Type:PsApiManagementApi
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Name

Web-API-naam. Openbare naam van de API zoals deze wordt weergegeven in de ontwikkelaars- en beheerportals. Deze parameter is vereist.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-OpenIdProviderId

OpenId-autorisatieserver-id. Deze parameter is optioneel. De standaardwaarde is $null. Moet worden opgegeven als BearerTokenSendingMethods is opgegeven.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-PassThru

Als dit is opgegeven, wordt het exemplaar van het type Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi weergegeven dat de set-API vertegenwoordigt.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Path

Web-API-pad. Laatste deel van de openbare URL van de API. Deze URL wordt gebruikt door API-consumenten voor het verzenden van aanvragen naar de webservice. Moet 1 tot 400 tekens lang zijn. Deze parameter is optioneel. De standaardwaarde is $null.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Protocols

Web-API-protocollen (http, https). Protocollen over welke API beschikbaar wordt gemaakt. Deze parameter is vereist. De standaardwaarde is $null.

Type:PsApiManagementSchema[]
Geaccepteerde waarden:Http, Https
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-ServiceUrl

Een URL van de webservice die de API weergeeft. Deze URL wordt alleen gebruikt door Azure API Management en wordt niet openbaar gemaakt. Moet 1 tot 2000 tekens lang zijn. Deze parameter is vereist.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SubscriptionKeyHeaderName

Naam van abonnementssleutelheader. Deze parameter is optioneel. De standaardwaarde is $null.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SubscriptionKeyQueryParamName

Naam van queryreeksparameter voor abonnementssleutel. Deze parameter is optioneel. De standaardwaarde is $null.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SubscriptionRequired

Vlag voor het afdwingen van SubscriptionRequired voor aanvragen naar de API. Deze parameter is optioneel.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

String

PsApiManagementContext

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Uitvoerwaarden

PsApiManagementApi