Udostępnij za pośrednictwem

Set-AzApiManagementApiVersionSet

  • Odwołanie
Moduł:
Az.ApiManagement

Aktualizuje zestaw wersji interfejsu API w kontekście usługi API Management.

Składnia

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

Opis

Polecenie cmdlet Set-AzApiManagementApiVersionSet modyfikuje zestaw wersji interfejsu API usługi Azure API Management.

Przykłady

Przykład 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"

To polecenie aktualizuje istniejący zestaw wersji interfejsu API przy użyciu schematu przechowywania wersji Header i parametru nagłówka api-version.

Parametry

-ApiVersionSetId

Identyfikator nowego zestawu wersji interfejsu API.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Confirm

Prosi o potwierdzenie przed uruchomieniem cmdletu.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Context

Wystąpienie elementu PsApiManagementContext. Ten parametr jest wymagany.

Typ:PsApiManagementContext
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Description

Opis zestawu wersji interfejsu API.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-HeaderName

Wartość nagłówek, która będzie zawierać informacje o wersji. Jeśli wybrano nagłówek schematu przechowywania wersji, należy określić tę wartość.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-InputObject

Wystąpienie elementu PsApiManagementApiVersionSet. Ten parametr jest wymagany.

Typ:PsApiManagementApiVersionSet
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Name

Nazwa zestawu ApiVersion. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-PassThru

Jeśli zostanie określone wystąpienie klasy Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet reprezentujące zmodyfikowany element apiVersionSet, zostanie zapisane w danych wyjściowych.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-QueryName

Wartość Zapytanie, która będzie zawierać informacje o wersji. Jeśli wybrano zapytanie schematu przechowywania wersji, należy określić tę wartość.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Scheme

Schemat przechowywania wersji do wybrania dla zestawu przechowywania wersji interfejsu API. Ten parametr jest opcjonalny.

Typ:PsApiManagementVersioningScheme
Dopuszczalne wartości:Segment, Query, Header
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie jest uruchomiony.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

Dane wyjściowe