Set-AzApiManagementApiRevision
Modifica uma revisão de API
Sintaxe
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
O cmdlet Set-AzApiManagementApiRevision modifica uma revisão da API de Gerenciamento de API do Azure.
Exemplos
Exemplo 1: Modificar uma revisão 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"O cmdlet atualiza a 2 revisão da API echo-api com uma nova descrição, protocolo e caminho.
Parâmetros
-ApiId
Identificador da API existente. Este parâmetro é obrigatório.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-ApiRevision
Identificador da revisão da API existente. Este parâmetro é obrigatório.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-AuthorizationScope
Escopo de operações OAuth. Esse parâmetro é opcional. O valor padrão é $null.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-AuthorizationServerId
Identificador do servidor de autorização OAuth. Esse parâmetro é opcional. O valor padrão é $null. Deve ser especificado se AuthorizationScope for especificado.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-BearerTokenSendingMethod
Mecanismo do servidor de autorização OpenId pelo qual o token de acesso é passado para a API. Consulte https://datatracker.ietf.org/doc/html/rfc6749#section-4. Esse parâmetro é opcional. O valor padrão é $null.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
| Tipo: | SwitchParameter |
| Aliases: | cf |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Context
Instância de PsApiManagementContext. Este parâmetro é obrigatório.
| Tipo: | PsApiManagementContext |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.
| Tipo: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Description
Descrição da API Web. Esse parâmetro é opcional.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-InputObject
Instância de PsApiManagementApi. Este parâmetro é obrigatório.
| Tipo: | PsApiManagementApi |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Name
Nome da API Web. Nome público da API como ela apareceria nos portais de desenvolvedor e administrador. Este parâmetro é obrigatório.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-OpenIdProviderId
Identificador do servidor de autorização OpenId. Esse parâmetro é opcional. O valor padrão é $null. Deve ser especificado se BearerTokenSendingMethods for especificado.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-PassThru
Se especificado, a instância de Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi representa a API definida.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Path
Caminho da API Web. Última parte da URL pública da API. Essa URL será usada pelos consumidores da API para enviar solicitações ao serviço Web. Deve ter de 1 a 400 caracteres. Esse parâmetro é opcional. O valor padrão é $null.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Protocols
Protocolos de API Web (http, https). Protocolos pelos quais a API é disponibilizada. Este parâmetro é obrigatório. O valor padrão é $null.
| Tipo: | PsApiManagementSchema[] |
| Valores aceitos: | Http, Https |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-ServiceUrl
Uma URL do serviço Web que expõe a API. Essa URL será usada apenas pelo Gerenciamento de API do Azure e não será tornada pública. Deve ter de 1 a 2000 caracteres. Este parâmetro é obrigatório.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-SubscriptionKeyHeaderName
Nome do cabeçalho da chave de assinatura. Esse parâmetro é opcional. O valor padrão é $null.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-SubscriptionKeyQueryParamName
Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura. Esse parâmetro é opcional. O valor padrão é $null.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-SubscriptionRequired
Sinalizador para impor SubscriptionRequired para solicitações à API. Esse parâmetro é opcional.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
| Tipo: | SwitchParameter |
| Aliases: | wi |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |