New-AzApiManagementApiVersionSet

  • Referenz
Modul:
Az.ApiManagement

Erstellt einen API-Versionssatz.

Syntax

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

Beschreibung

Das Cmdlet New-AzApiManagementApiVersionSet erstellt eine API-Versionssatzentität im Azure API Management-Kontext.

Beispiele

Beispiel 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

Mit diesem Befehl wird ein API-Versionssatz erstellt, der das Versionsverwaltungsschema Query und den Abfrageparameter api-versionangibt.

Parameter

-ApiVersionSetId

Bezeichner für den neuen API-Versionssatz. Dieser Parameter ist optional. Wenn kein Bezeichner angegeben wird, wird ein Bezeichner generiert.

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

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-Context

Instanz von PsApiManagementContext. Dieser Parameter ist erforderlich.

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

-DefaultProfile

Anmeldeinformationen, Konto, Mandant und Abonnement für die Kommunikation mit Azure

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

-Description

Beschreibung des API-Versionssatzes.

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

-HeaderName

Der Headerwert, der die Versionsverwaltungsinformationen enthält. Wenn VersionsverwaltungsschemaHEADer ausgewählt wird, muss dieser Wert angegeben werden.

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

-Name

Der Name des ApiVersion-Satzes. Dieser Parameter ist erforderlich.

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

-QueryName

Der Abfragewert, der die Versionsverwaltungsinformationen enthält. Wenn die Versionsverwaltungsschemaabfrage ausgewählt wird, muss dieser Wert angegeben werden.

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

-Scheme

Versionsverwaltungsschema, das für den API-Versionsverwaltungssatz ausgewählt werden soll. Dieser Parameter ist erforderlich.

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

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

PsApiManagementContext

String

PsApiManagementVersioningScheme

Ausgaben

PsApiManagementApiVersionSet