Sdílet prostřednictvím

Set-AzApiManagementApiVersionSet

  • Reference
Modul:
Az.ApiManagement

Aktualizuje sadu verzí rozhraní API v kontextu služby API Management.

Syntaxe

Set-AzApiManagementApiVersionSet
   -Context <PsApiManagementContext>
   -ApiVersionSetId <String>
   [-Name <String>]
   [-Scheme <PsApiManagementVersioningScheme>]
   [-HeaderName <String>]
   [-QueryName <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementApiVersionSet
   -InputObject <PsApiManagementApiVersionSet>
   [-Name <String>]
   [-Scheme <PsApiManagementVersioningScheme>]
   [-HeaderName <String>]
   [-QueryName <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Rutina Set-AzApiManagementApiVersionSet upraví sadu verzí rozhraní API služby Azure API Management.

Příklady

Příklad 1

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId "query-verion-set" -Scheme Header -HeaderName "api-version" -Description "Azure version header string"

Tento příkaz aktualizuje existující sadu verzí rozhraní API pomocí schématu správy verzí Header a parametru header api-version.

Parametry

-ApiVersionSetId

Identifikátor nové sady verzí rozhraní API

Typ:String
Position:Named
Default value:None
Vyžadováno:True
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 sady verzí rozhraní API

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

-HeaderName

Hodnota záhlaví, která bude obsahovat informace o správě verzí. Pokud je zvolena funkce HEADER schématu správy verzí, musí být tato hodnota zadána.

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 PsApiManagementApiVersionSet. Tento parametr je povinný.

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

-Name

Název sady ApiVersion. 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

-PassThru

Pokud je zadána instance Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet typu představující upravený apiVersionSet se zapíše do výstupu.

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

-QueryName

Hodnota dotazu, která bude obsahovat informace o správě verzí. Pokud je zvolen dotaz schématu správy verzí, musí být tato hodnota zadána.

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

-Scheme

Schéma správy verzí, které se má vybrat pro sadu verzí rozhraní API. Tento parametr je volitelný.

Typ:PsApiManagementVersioningScheme
Přípustné hodnoty:Segment, Query, Header
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

PsApiManagementContext

PsApiManagementApiVersionSet

String

PsApiManagementVersioningScheme

Výstupy

PsApiManagementApiVersionSet