Set-AzApiManagementOperation

  • Referenz
Modul:
Az.ApiManagement

Legt API-Vorgangsdetails fest.

Syntax

Set-AzApiManagementOperation
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-ApiRevision <String>]
   -OperationId <String>
   -Name <String>
   -Method <String>
   -UrlTemplate <String>
   [-Description <String>]
   [-TemplateParameters <PsApiManagementParameter[]>]
   [-Request <PsApiManagementRequest>]
   [-Responses <PsApiManagementResponse[]>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Set-AzApiManagementOperation legt API-Vorgangsdetails fest.

Beispiele

Beispiel 1: Festlegen der Vorgangsdetails

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementOperation -Context $apimContext -ApiId $APIID -OperationId $OperationId -Name "Get Resource" -Method GET -UrlTemplate "/newresource" -Description "Use this operation to get newresource"

Mit diesem Befehl werden die Vorgangsdetails für die API-Verwaltung festgelegt.

Beispiel 2

Legt API-Vorgangsdetails fest. (automatisch generiert)

Set-AzApiManagementOperation -ApiId '0001' -Context <PsApiManagementContext> -Method 'GET' -Name 'ContosoApi' -OperationId 'Operation003' -UrlTemplate '/newresource'

Parameter

-ApiId

Gibt den Bezeichner der API an.

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

-ApiRevision

Bezeichner der API-Revision. Dieser Parameter ist optional. Wenn nicht angegeben, wird der Vorgang in der derzeit aktiven API-Revision aktualisiert.

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

Gibt eine Instanz von PsApiManagementContext an.

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

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

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

-Description

Gibt die Beschreibung des neuen Vorgangs an.

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

-Method

Gibt die HTTP-Methode des neuen Vorgangs an.

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

-Name

Gibt den Anzeigenamen des neuen Vorgangs an.

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

-OperationId

Gibt den Bezeichner des vorhandenen Vorgangs an.

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

-PassThru

Passthru

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

-Request

Gibt die Vorgangsanforderungsdetails an.

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

-Responses

Gibt ein Array möglicher Vorgangsantworten an.

Type:PsApiManagementResponse[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TemplateParameters

Gibt ein Array oder parameter an, das in Der Parameter UrlTemplate definiert ist. Wenn Sie keinen Wert angeben, wird ein Standardwert basierend auf der UrlTemplate generiert. Verwenden Sie den Parameter, um weitere Details zu Parametern wie Beschreibung, Typ und anderen möglichen Werten zu geben.

Type:PsApiManagementParameter[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UrlTemplate

Gibt die URL-Vorlage an. Beispiel: kunden/{cid}/orders/{oid}/?date={date}.

Type:String
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

PsApiManagementParameter[]

PsApiManagementRequest

PsApiManagementResponse[]

SwitchParameter

Ausgaben

PsApiManagementOperation