Set-AzApiManagementApiRevision
Modifica una revisión de API
Syntax
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 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 2 revisión 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApiRevision
Identificador de la revisión de API existente. Este parámetro es obligatorio.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationScope
Ámbito de operaciones de OAuth. Este parámetro es opcional. El valor predeterminado es $null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| 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
Instancia de PsApiManagementContext. Este parámetro es obligatorio.
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Credenciales, cuenta, inquilino y suscripción usados 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
Descripción de la API web. Este parámetro es opcional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Instancia de PsApiManagementApi. Este parámetro es obligatorio.
| Type: | PsApiManagementApi |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
Si se especifica entonces la instancia de Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi type que representa la API set.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | PsApiManagementSchema[] |
| Accepted values: | Http, Https |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionKeyHeaderName
Nombre del encabezado de clave de suscripción. Este parámetro es opcional. El valor predeterminado es $null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionRequired
Marca para aplicar SubscriptionRequired para las solicitudes a la API. Este parámetro es opcional.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |