Compartir a través de


Set-AzApiManagementOperation

Establece los detalles de la operación de API.

Sintaxis

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

Description

El cmdlet Set-AzApiManagementOperation establece los detalles de la operación de API.

Ejemplos

Ejemplo 1: Establecimiento de los detalles de la operación

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

Este comando establece los detalles de la operación para API Management.

Ejemplo 2

Establece los detalles de la operación de API. (generado automáticamente)

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

Parámetros

-ApiId

Especifica el identificador de la API.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ApiRevision

Identificador de revisión de API. Este parámetro es opcional. Si no se especifica, la operación se actualizará en la revisión de api activa actualmente.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Alias:cf
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Context

Especifica una instancia de PsApiManagementContext.

Tipo:PsApiManagementContext
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Description

Especifica la descripción de la nueva operación.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Method

Especifica el método HTTP de la nueva operación.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Name

Especifica el nombre para mostrar de la nueva operación.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-OperationId

Especifica el identificador de la operación existente.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-PassThru

passthru

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Request

Especifica los detalles de la solicitud de operación.

Tipo:PsApiManagementRequest
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Responses

Especifica una matriz de posibles respuestas de operación.

Tipo:PsApiManagementResponse[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-TemplateParameters

Especifica una matriz o parámetros definidos en el parámetro UrlTemplate. Si no especifica un valor, se generará un valor predeterminado en función de UrlTemplate. Use el parámetro para proporcionar más detalles sobre los parámetros, como la descripción, el tipo y otros valores posibles.

Tipo:PsApiManagementParameter[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-UrlTemplate

Especifica la plantilla de dirección URL. Por ejemplo: customers/{cid}/orders/{oid}/?date={date}.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

PsApiManagementContext

String

PsApiManagementParameter[]

PsApiManagementRequest

PsApiManagementResponse[]

SwitchParameter

Salidas

PsApiManagementOperation