Set-AzApiManagementApiVersionSet

  • Referenz
Modul:
Az.ApiManagement

Aktualisiert einen API-Versionssatz im API-Verwaltungskontext.

Syntax

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

Beschreibung

Das Cmdlet Set-AzApiManagementApiVersionSet ändert einen Versionssatz der Azure API-Verwaltungs-API.

Beispiele

Beispiel 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"

Mit diesem Befehl wird ein vorhandenes API-Versionssatz mit Versionsverwaltungsschema Header und Headerparameter api-versionaktualisiert.

Parameter

-ApiVersionSetId

Bezeichner für den neuen API-Versionssatz.

Type:String
Position:Named
Default value:None
Required:True
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

-InputObject

Instanz von PsApiManagementApiVersionSet. Dieser Parameter ist erforderlich.

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

-Name

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

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

-PassThru

Wenn angegeben, wird die Instanz von Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet-Typ, der den geänderten apiVersionSet-Typ darstellt, in die Ausgabe geschrieben.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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 optional.

Type:PsApiManagementVersioningScheme
Accepted values:Segment, Query, Header
Position:Named
Default value:None
Required:False
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

PsApiManagementApiVersionSet

String

PsApiManagementVersioningScheme

Ausgaben

PsApiManagementApiVersionSet