Sdílet prostřednictvím

Set-AzApiManagementApiRevision

  • Reference
Modul:
Az.ApiManagement

Upraví revizi rozhraní API.

Syntaxe

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

Rutina Set-AzApiManagementApiRevision upraví revizi rozhraní API služby Azure API Management.

Příklady

Příklad 1: Úprava revize rozhraní 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"

Rutina aktualizuje 2 revizi echo-api rozhraní API novým popisem, protokolem a cestou.

Parametry

-ApiId

Identifikátor existujícího rozhraní API. Tento parametr je povinný.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ApiRevision

Identifikátor existující revize rozhraní API. Tento parametr je povinný.

Typ:String
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-AuthorizationScope

Rozsah operací OAuth Tento parametr je volitelný. Výchozí hodnota je $null.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-AuthorizationServerId

Identifikátor autorizačního serveru OAuth. Tento parametr je volitelný. Výchozí hodnota je $null. Je nutné zadat, pokud je zadán AuthorizationScope.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-BearerTokenSendingMethod

Mechanismus autorizačního serveru OpenId, pomocí kterého se přístupový token předává rozhraní API. Projděte si https://datatracker.ietf.org/doc/html/rfc6749#section-4. Tento parametr je volitelný. Výchozí hodnota je $null.

Typ:String[]
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Confirm

Před spuštěním rutiny vás vyzve k potvrzení.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Context

Instance of PsApiManagementContext. Tento parametr je povinný.

Typ:PsApiManagementContext
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Description

Popis webového rozhraní API Tento parametr je volitelný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-InputObject

Instance of PsApiManagementApi. Tento parametr je povinný.

Typ:PsApiManagementApi
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Name

Název webového rozhraní API Veřejný název rozhraní API, jak by se zobrazovalo na portálech pro vývojáře a správce Tento parametr je povinný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-OpenIdProviderId

Identifikátor autorizačního serveru OpenId Tento parametr je volitelný. Výchozí hodnota je $null. Je nutné zadat, pokud je zadán bearerTokenSendingMethods.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-PassThru

Pokud je zadaná instance Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi představující nastavené rozhraní API.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Path

Cesta k webovému rozhraní API Poslední část veřejné adresy URL rozhraní API Tuto adresu URL budou uživatelé rozhraní API používat k odesílání požadavků do webové služby. Musí mít délku 1 až 400 znaků. Tento parametr je volitelný. Výchozí hodnota je $null.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Protocols

Protokoly webového rozhraní API (http, https). Protokoly, u kterých je rozhraní API dostupné. Tento parametr je povinný. Výchozí hodnota je $null.

Typ:PsApiManagementSchema[]
Přípustné hodnoty:Http, Https
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ServiceUrl

Adresa URL webové služby, která rozhraní API vystavuje. Tuto adresu URL bude používat jenom azure API Management a nebude veřejná. Musí mít délku 1 až 2 000 znaků. Tento parametr je povinný.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SubscriptionKeyHeaderName

Název hlavičky klíče předplatného Tento parametr je volitelný. Výchozí hodnota je $null.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SubscriptionKeyQueryParamName

Název parametru řetězce dotazu klíče předplatného Tento parametr je volitelný. Výchozí hodnota je $null.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-SubscriptionRequired

Příznak pro vynucení subscriptionRequired pro požadavky na rozhraní API Tento parametr je volitelný.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-WhatIf

Ukazuje, co se stane, když se rutina spustí. Rutina se nespustí.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

String

PsApiManagementContext

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Výstupy

PsApiManagementApi