Condividi tramite

Set-AzApiManagementApi

  • Riferimento
Modulo:
Az.ApiManagement

Modifica un'API.

Sintassi

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>]

Descrizione

Il cmdlet Set-AzApiManagementApi modifica un'API Gestione API di Azure.

Esempio

Esempio 1: Modificare un'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"

Esempio 2: Aggiungere un'API a un oggetto ApiVersionSet esistente

$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

Questo esempio aggiunge un'API a un set di versioni dell'API esistente

Esempio 3: Modificare il valore di Backend ServiceUrl in cui l'API punta a

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

In questo esempio viene aggiornato ServiceUrl a cui echo-api punta .

Parametri

-ApiId

Specifica l'ID dell'API da modificare.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiType

Tipo di API da creare (http, soap, websocket, graphql). Il parametro è facoltativo.

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

Specifica l'ambito delle operazioni OAuth. Il valore predefinito è $Null.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AuthorizationServerId

Specifica l'identificatore del server di autorizzazione OAuth. Il valore predefinito è $Null. È necessario specificare questo parametro se authorizationScope è specificato.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-BearerTokenSendingMethod

Meccanismo del server di autorizzazione OpenId tramite il quale viene passato il token di accesso all'API. Fare riferimento a https://datatracker.ietf.org/doc/html/rfc6749#section-4. Il parametro è facoltativo. Il valore predefinito è $null.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContactEmail

Indirizzo di posta elettronica della persona o dell'organizzazione di contatto. DEVE essere nel formato di un indirizzo di posta elettronica. Il parametro è facoltativo.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContactName

Nome di identificazione della persona o dell'organizzazione di contatto. Il parametro è facoltativo.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ContactUrl

URL che punta alle informazioni di contatto. DEVE essere nel formato di un URL. Il parametro è facoltativo.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Context

Specifica un oggetto PsApiManagementContext .

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifica una descrizione per l'API Web.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Istanza di PsApiManagementApi. Questo parametro è obbligatorio.

Type:PsApiManagementApi
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LicenseName

Nome della licenza usato per l'API. Il parametro è facoltativo.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-LicenseUrl

URL delle condizioni di servizio per l'API. Il parametro è facoltativo.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifica il nome dell'API Web.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OpenIdProviderId

Identificatore del server di autorizzazione OpenId. Il parametro è facoltativo. Il valore predefinito è $null. Deve essere specificato se è specificato BearerTokenSendingMethods.

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

Specifica il percorso dell'API Web, ovvero l'ultima parte dell'URL pubblico dell'API. Questo URL viene usato dai consumer dell'API per inviare richieste al servizio Web e deve avere una lunghezza di 400 caratteri. Il valore predefinito è $Null.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Protocols

Specifica una matrice di protocolli API Web. psdx_paramvalues http e https. Si tratta dei protocolli Web su cui viene resa disponibile l'API. Il valore predefinito è $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

Specifica l'URL del servizio Web che espone l'API. Questo URL viene usato solo da Azure Gestione API e non viene reso pubblico. L'URL deve avere una lunghezza di 2000 caratteri.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionKeyHeaderName

Specifica il nome dell'intestazione della chiave di sottoscrizione. Il valore predefinito è $Null.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionKeyQueryParamName

Specifica il nome del parametro della stringa di query della chiave di sottoscrizione. Il valore predefinito è $Null.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionRequired

Flag per applicare SubscriptionRequired per le richieste all'API. Il parametro è facoltativo.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TermsOfServiceUrl

URL delle condizioni di servizio per l'API. Il parametro è facoltativo.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Input

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema[]

SwitchParameter

Output

PsApiManagementApi