Set-AzApiManagementApi
Modifica uma API.
Syntax
Set-AzApiManagementApi
-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]
[-ApiType <PsApiManagementApiType>]
[-TermsOfServiceUrl <String>]
[-ContactName <String>]
[-ContactUrl <String>]
[-ContactEmail <String>]
[-LicenseName <String>]
[-LicenseUrl <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzApiManagementApi
-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]
[-ApiType <PsApiManagementApiType>]
[-TermsOfServiceUrl <String>]
[-ContactName <String>]
[-ContactUrl <String>]
[-ContactEmail <String>]
[-LicenseName <String>]
[-LicenseUrl <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
O cmdlet Set-AzApiManagementApi modifica uma API de Gerenciamento de API do Azure.
Exemplos
Exemplo 1: Modificar uma API
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"Exemplo 2: Adicionar uma API a um ApiVersionSet existente
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$versionSet = New-AzApiManagementApiVersionSet -Context $context -Name "Echo API Version Set" -Scheme Segment -Description "version set sample"
$api = Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId "echo-api"
$api.ApiVersionSetId = $versionSet.Id
$api.ApiVersion = "v1"
$api.ApiVersionSetDescription = $versionSet.Description
Set-AzApiManagementApi -InputObject $api -PassThruEste exemplo adiciona uma API a um conjunto de versões de API existente
Exemplo 3: Alterar o ServiceUrl de back-end para onde a API está apontando
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$updatedApiServiceUrl = "http://newechoapi.cloudapp.net/updateapi"
$updatedApi = Set-AzApiManagementApi -Context $ApiMgmtContext -ApiId $echoApiId -ServiceUrl $updatedApiServiceUrlEste exemplo atualiza o ServiceUrl para o qual o echo-api está apontando.
Parâmetros
-ApiId
Especifica a ID da API a ser modificada.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApiType
Tipo de API a criar (http, soap, websocket, graphql). Este parâmetro é opcional.
| Type: | Nullable<T>[PsApiManagementApiType] |
| Accepted values: | Http, Soap, WebSocket, GraphQL |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationScope
Especifica o escopo das operações OAuth. O valor padrão é $Null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AuthorizationServerId
Especifica o identificador do servidor de autorização OAuth. O valor padrão é $Null. Você deve especificar esse parâmetro se AuthorizationScope for especificado.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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. Este parâmetro é opcional. O valor padrão é $null.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ContactEmail
O endereço de e-mail da pessoa/organização de contato. DEVE estar no formato de um endereço de e-mail. Este parâmetro é opcional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ContactName
O nome de identificação da pessoa/organização de contacto. Este parâmetro é opcional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ContactUrl
O URL apontando para as informações de contato. DEVE estar no formato de um URL. Este parâmetro é opcional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Context
Especifica um objeto PsApiManagementContext .
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Especifica uma descrição para a API da Web.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
Instância de PsApiManagementApi. Este parâmetro é obrigatório.
| Type: | PsApiManagementApi |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LicenseName
O nome da licença usado para a API. Este parâmetro é opcional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LicenseUrl
Um URL para os Termos de Serviço da API. Este parâmetro é opcional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Especifica o nome da API da Web.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OpenIdProviderId
Identificador do servidor de autorização OpenId. Este parâmetro é opcional. O valor padrão é $null. Deve ser especificado se BearerTokenSendingMethods for especificado.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-Path
Especifica o caminho da API da Web, que é a última parte da URL pública da API. Essa URL é usada por consumidores de API para enviar solicitações ao serviço Web e deve ter de um a 400 caracteres. O valor padrão é $Null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Protocols
Especifica uma matriz de protocolos de API da Web. psdx_paramvalues http e https. Estes são os protocolos da Web sobre os quais a API é disponibilizada. O valor padrão é $Null.
| Type: | PsApiManagementSchema[] |
| Accepted values: | Http, Https, Ws, Wss |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceUrl
Especifica a URL do serviço Web que expõe a API. Essa URL é usada somente pelo Gerenciamento de API do Azure e não é tornada pública. O URL deve ter de um a 2000 caracteres.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionKeyHeaderName
Especifica o nome do cabeçalho da chave de assinatura. O valor padrão é $Null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionKeyQueryParamName
Especifica o nome do parâmetro de cadeia de caracteres de consulta de chave de assinatura. O valor padrão é $Null.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionRequired
Sinalizador para impor SubscriptionRequired para solicitações à Api. Este parâmetro é opcional.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TermsOfServiceUrl
Um URL para os Termos de Serviço da API. Este parâmetro é opcional.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Entradas
Saídas
Ligações Relacionadas
Azure PowerShell
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários