Set-AzApiManagementApiRevision
Modifica una revisión de API
Sintaxis
Set-AzApiManagementApiRevision
-ApiRevision <String>
-Context <PsApiManagementContext>
-ApiId <String>
[-Name <String>]
[-Description <String>]
[-ServiceUrl <String>]
[-Path <String>]
[-Protocols <PsApiManagementSchema[]>]
[-AuthorizationServerId <String>]
[-AuthorizationScope <String>]
[-OpenIdProviderId <String>]
[-BearerTokenSendingMethod <String[]>]
[-SubscriptionKeyHeaderName <String>]
[-SubscriptionKeyQueryParamName <String>]
[-SubscriptionRequired]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzApiManagementApiRevision
-InputObject <PsApiManagementApi>
[-Name <String>]
[-Description <String>]
[-ServiceUrl <String>]
[-Path <String>]
[-Protocols <PsApiManagementSchema[]>]
[-AuthorizationServerId <String>]
[-AuthorizationScope <String>]
[-OpenIdProviderId <String>]
[-BearerTokenSendingMethod <String[]>]
[-SubscriptionKeyHeaderName <String>]
[-SubscriptionKeyQueryParamName <String>]
[-SubscriptionRequired]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
El cmdlet Set-AzApiManagementApiRevision modifica una revisión de la API de Azure API Management.
Ejemplos
Ejemplo 1: Modificación de una revisión de API
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiRevision -Context $ApiMgmtContext -ApiId "echo-api" -ApiRevision "2" -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"El cmdlet actualiza la revisión 2 de la API echo-api con una nueva descripción, protocolo y ruta de acceso.
Parámetros
-ApiId
Identificador de la API existente. Este parámetro es obligatorio.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-ApiRevision
Identificador de la revisión de API existente. Este parámetro es obligatorio.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-AuthorizationScope
Ámbito de operaciones de OAuth. Este parámetro es opcional. El valor predeterminado es $null.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-AuthorizationServerId
Identificador del servidor de autorización de OAuth. Este parámetro es opcional. El valor predeterminado es $null. Debe especificarse si se especifica AuthorizationScope.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-BearerTokenSendingMethod
Mecanismo del servidor de autorización openId mediante el que se pasa el token de acceso a la API. Consulte https://datatracker.ietf.org/doc/html/rfc6749#section-4. Este parámetro es opcional. El valor predeterminado es $null.
| Tipo: | String[] |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-Confirm
Le pide 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
Instancia de PsApiManagementContext. Este parámetro es obligatorio.
| 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
Descripción de la API web. Este parámetro es opcional.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-InputObject
Instancia de PsApiManagementApi. Este parámetro es obligatorio.
| Tipo: | PsApiManagementApi |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | True |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-Name
Nombre de la API web. Nombre público de la API tal como aparecería en los portales para desarrolladores y administradores. Este parámetro es obligatorio.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-OpenIdProviderId
Identificador del servidor de autorización openId. Este parámetro es opcional. El valor predeterminado es $null. Debe especificarse si se especifica BearerTokenSendingMethods.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-PassThru
Si se especifica entonces la instancia de Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi type que representa la API set.
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-Path
Ruta de acceso de API web. Última parte de la dirección URL pública de la API. Los consumidores de API usarán esta dirección URL para enviar solicitudes al servicio web. Debe tener entre 1 y 400 caracteres. Este parámetro es opcional. El valor predeterminado es $null.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-Protocols
Protocolos de API web (http, https). Protocolos sobre los que está disponible la API. Este parámetro es obligatorio. El valor predeterminado es $null.
| Tipo: | PsApiManagementSchema[] |
| Valores aceptados: | Http, Https |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-ServiceUrl
Dirección URL del servicio web que expone la API. Azure API Management solo usará esta dirección URL y no se hará pública. Debe tener entre 1 y 2000 caracteres. Este parámetro es obligatorio.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-SubscriptionKeyHeaderName
Nombre del encabezado de clave de suscripción. Este parámetro es opcional. El valor predeterminado es $null.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-SubscriptionKeyQueryParamName
Nombre del parámetro de la cadena de consulta de clave de suscripción. Este parámetro es opcional. El valor predeterminado es $null.
| Tipo: | String |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-SubscriptionRequired
Marca para aplicar SubscriptionRequired para las solicitudes a la API. Este parámetro es opcional.
| Tipo: | SwitchParameter |
| Posición: | Named |
| Valor predeterminado: | None |
| Requerido: | False |
| Aceptar entrada de canalización: | True |
| Aceptar caracteres comodín: | False |
-WhatIf
Muestra lo que sucedería si el cmdlet se ejecuta. 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 |
