Dela via

Set-AzApiManagementApiRevision

  • Referens
Modul:
Az.ApiManagement

Ändrar en 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>]

Description

Cmdleten Set-AzApiManagementApiRevision ändrar en Version av Azure API Management API.

Exempel

Exempel 1: Ändra en 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"

Cmdleten uppdaterar 2 revision av API-echo-api med en ny beskrivning, ett protokoll och en ny sökväg.

Parametrar

-ApiId

Identifierare för befintligt API. Den här parametern krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ApiRevision

Identifierare för befintlig API-revision. Den här parametern krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-AuthorizationScope

Omfång för OAuth-åtgärder. Den här parametern är valfri. Standardvärdet är $null.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-AuthorizationServerId

OAuth-auktoriseringsserveridentifierare. Den här parametern är valfri. Standardvärdet är $null. Måste anges om AuthorizationScope har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-BearerTokenSendingMethod

OpenId-auktoriseringsservermekanism med vilken åtkomsttoken skickas till API:et. Se https://datatracker.ietf.org/doc/html/rfc6749#section-4. Den här parametern är valfri. Standardvärdet är $null.

Typ:String[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Context

Instans av PsApiManagementContext. Den här parametern krävs.

Typ:PsApiManagementContext
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Description

Beskrivning av webb-API. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-InputObject

Instans av PsApiManagementApi. Den här parametern krävs.

Typ:PsApiManagementApi
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Name

Webb-API-namn. Offentligt namn på API:et så som det skulle visas på utvecklar- och administratörsportalerna. Den här parametern krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-OpenIdProviderId

OpenId-auktoriseringsserveridentifierare. Den här parametern är valfri. Standardvärdet är $null. Måste anges om BearerTokenSendingMethods har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-PassThru

Om det anges anger du instansen av typen Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi som representerar det angivna API:et.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Path

Webb-API-sökväg. Sista delen av API:ets offentliga URL. Den här URL:en används av API-konsumenter för att skicka begäranden till webbtjänsten. Måste vara mellan 1 och 400 tecken långt. Den här parametern är valfri. Standardvärdet är $null.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Protocols

Webb-API-protokoll (http, https). Protokoll som API:et görs tillgängligt för. Den här parametern krävs. Standardvärdet är $null.

Typ:PsApiManagementSchema[]
Godkända värden:Http, Https
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ServiceUrl

En URL till webbtjänsten som exponerar API:et. Den här URL:en används endast av Azure API Management och kommer inte att offentliggöras. Måste vara mellan 1 och 2 000 tecken långt. Den här parametern krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SubscriptionKeyHeaderName

Namn på prenumerationsnyckelhuvud. Den här parametern är valfri. Standardvärdet är $null.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SubscriptionKeyQueryParamName

Parameternamn för frågesträng för prenumerationsnyckel. Den här parametern är valfri. Standardvärdet är $null.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SubscriptionRequired

Flagga för att framtvinga SubscriptionRequired för begäranden till API:et. Den här parametern är valfri.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om cmdleten körs. Cmdleten körs inte.

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

String

PsApiManagementContext

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Utdata

PsApiManagementApi