Compartir a través de

Set-AzApiManagementApi

  • Referencia
Módulo:
Az.ApiManagement

Modifica una API.

Sintaxis

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

El cmdlet Set-AzApiManagementApi modifica una API de Azure API Management.

Ejemplos

Ejemplo 1: Modificación de una 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"

Ejemplo 2: Adición de una API a un elemento 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 -PassThru

En este ejemplo se agrega una API a un conjunto de versiones de API existente.

Ejemplo 3: Cambiar el serviceUrl de back-end al que apunta la API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$updatedApiServiceUrl = "http://newechoapi.cloudapp.net/updateapi"
$updatedApi = Set-AzApiManagementApi -Context $ApiMgmtContext -ApiId $echoApiId -ServiceUrl $updatedApiServiceUrl

En este ejemplo se actualiza ServiceUrl echo-api al que apunta.

Parámetros

-ApiId

Especifica el identificador de la API que se va a modificar.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ApiType

Tipo de API que se va a crear (http, soap, websocket, graphql). Este parámetro es opcional.

Tipo:Nullable<T>[PsApiManagementApiType]
Valores aceptados:Http, Soap, WebSocket, GraphQL
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-AuthorizationScope

Especifica el ámbito de las operaciones de OAuth. 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

Especifica el identificador del servidor de autorización de OAuth. El valor predeterminado es $Null. Debe especificar este parámetro 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

-ContactEmail

Dirección de correo electrónico de la persona o organización de contacto. DEBE tener el formato de una dirección de correo electrónico. 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

-ContactName

Nombre de identificación de la persona o organización de contacto. 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

-ContactUrl

Dirección URL que apunta a la información de contacto. DEBE estar en el formato de una dirección URL. 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

-Context

Especifica un objeto PsApiManagementContext .

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

Especifica una descripción de la API web.

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

-LicenseName

Nombre de licencia que se usa para la API. 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

-LicenseUrl

Una dirección URL a los Términos del servicio para la API. 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

-Name

Especifica el nombre de la API web.

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

passthru

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Path

Especifica la ruta de acceso de la API web, que es la última parte de la dirección URL pública de la API. Los consumidores de API usan esta dirección URL para enviar solicitudes al servicio web y deben tener una longitud de 400 caracteres. 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

Especifica una matriz de protocolos de API web. psdx_paramvalues http y https. Estos son los protocolos web sobre los que está disponible la API. El valor predeterminado es $Null.

Tipo:PsApiManagementSchema[]
Valores aceptados:Http, Https, Ws, Wss
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ServiceUrl

Especifica la dirección URL del servicio web que expone la API. Esta dirección URL solo la usa Azure API Management y no se hace pública. La dirección URL debe tener entre 2000 caracteres y una longitud de 2000 caracteres.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-SubscriptionKeyHeaderName

Especifica el nombre del encabezado de clave de suscripción. 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

Especifica el nombre del parámetro de cadena de consulta de clave de suscripción. 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

-TermsOfServiceUrl

Una dirección URL a los Términos del servicio para la API. 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

Entradas

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Salidas

PsApiManagementApi