Udostępnij za pośrednictwem

Set-AzApiManagementOperation

  • Odwołanie
Moduł:
Az.ApiManagement

Ustawia szczegóły operacji interfejsu API.

Składnia

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

Opis

Polecenie cmdlet Set-AzApiManagementOperation ustawia szczegóły operacji interfejsu API.

Przykłady

Przykład 1. Ustawianie szczegółów operacji

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

To polecenie ustawia szczegóły operacji dla usługi API Management.

Przykład 2

Ustawia szczegóły operacji interfejsu API. (automatycznie wygenerowane)

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

Parametry

-ApiId

Określa identyfikator interfejsu API.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

Identyfikator poprawki interfejsu API. Ten parametr jest opcjonalny. Jeśli nie zostanie określona, operacja zostanie zaktualizowana w aktualnie aktywnej wersji interfejsu API.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:SwitchParameter
Aliases:cf
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Określa wystąpienie elementu PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

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

Typ:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Określa opis nowej operacji.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-Method

Określa metodę HTTP nowej operacji.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Określa nazwę wyświetlaną nowej operacji.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-OperationId

Określa identyfikator istniejącej operacji.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-Request

Określa szczegóły żądania operacji.

Typ:PsApiManagementRequest
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-Responses

Określa tablicę możliwych odpowiedzi operacji.

Typ:PsApiManagementResponse[]
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-TemplateParameters

Określa tablicę lub parametry zdefiniowane w parametrze UrlTemplate. Jeśli nie określisz wartości, zostanie wygenerowana wartość domyślna na podstawie elementu UrlTemplate. Użyj parametru , aby podać więcej szczegółów na temat parametrów, takich jak opis, typ i inne możliwe wartości.

Typ:PsApiManagementParameter[]
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:True
Accept wildcard characters:False

-UrlTemplate

Określa szablon adresu URL. Na przykład: customers/{cid}/orders/{oid}/?date={date}.

Typ:String
Position:Named
wartość domyślna:None
Wymagane:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Typ:SwitchParameter
Aliases:wi
Position:Named
wartość domyślna:None
Wymagane:False
Accept pipeline input:False
Accept wildcard characters:False

Dane wejściowe

PsApiManagementContext

String

PsApiManagementParameter[]

PsApiManagementRequest

PsApiManagementResponse[]

SwitchParameter

Dane wyjściowe

PsApiManagementOperation