Set-AzApiManagementOperation
Establece los detalles de la operación de API.
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>]
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | 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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Confirm
Le solicita su confirmación antes de ejecutar el cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Context
Especifica una instancia de PsApiManagementContext.
Type: | PsApiManagementContext |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Especifica la descripción de la nueva operación.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Method
Especifica el método HTTP de la nueva operación.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Especifica el nombre para mostrar de la nueva operación.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-OperationId
Especifica el identificador de la operación existente.
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
Especifica los detalles de la solicitud de operación.
Type: | PsApiManagementRequest |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Responses
Especifica una matriz de posibles respuestas de operación.
Type: | PsApiManagementResponse[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | 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.
Type: | PsApiManagementParameter[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UrlTemplate
Especifica la plantilla de dirección URL. Por ejemplo: customers/{cid}/orders/{oid}/?date={date}.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |