Share via

New-AzApiManagementApiVersionSet

  • Odwołanie
Moduł:
Az.ApiManagement

Tworzy zestaw wersji interfejsu API.

Składnia

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

Opis

Polecenie cmdlet New-AzApiManagementApiVersionSet tworzy jednostkę zestawu wersji interfejsu API w kontekście usługi Azure API Management.

Przykłady

Przykład 1

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementApiVersionSet -Context $ApiMgmtContext  -Name "newversion" -Scheme Header -HeaderName "x-ms-version" -Description "version by xmsversion"

ApiVersionSetId   : ea9a87cd-a699-4a75-bf7d-909846b91268
Description       : version by xmsversion
VersionQueryName  :
VersionHeaderName : x-ms-version
DisplayName       : newversion
VersioningScheme  : Header
Id                : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/ea9a87cd-a699-4a75-bf7d-909846b91268
ResourceGroupName : Api-Default-WestUS
ServiceName       : contoso

To polecenie tworzy zestaw wersji interfejsu API, który schemat Query przechowywania wersji i parametr api-versionZapytania .

Parametry

-ApiVersionSetId

Identyfikator nowego zestawu wersji interfejsu API. Ten parametr jest opcjonalny. Jeśli nie zostanie określony, zostanie wygenerowany identyfikator.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Wystąpienie elementu PsApiManagementContext. Ten parametr jest wymagany.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Opis zestawu wersji interfejsu API.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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ść.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Nazwa zestawu ApiVersion. Ten parametr jest wymagany.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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ść.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Scheme

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

Type:PsApiManagementVersioningScheme
Accepted values:Segment, Query, Header
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Dane wejściowe

PsApiManagementContext

String

PsApiManagementVersioningScheme

Dane wyjściowe

PsApiManagementApiVersionSet