Set-AzApiManagementApiRevision
Modifica una revisione API
Sintassi
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>] Descrizione
Il cmdlet Set-AzApiManagementApiRevision modifica una revisione dell'API di Gestione API di Azure.
Esempio
Esempio 1: Modificare una revisione DELL'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"Il cmdlet aggiorna la revisione 2 dell'API echo-api con una nuova descrizione, protocollo e percorso.
Parametri
-ApiId
Identificatore dell'API esistente. Questo parametro è obbligatorio.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-ApiRevision
Identificatore della revisione API esistente. Questo parametro è obbligatorio.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-AuthorizationScope
Ambito delle operazioni OAuth. Questo parametro è facoltativo. Il valore predefinito è $null.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-AuthorizationServerId
Identificatore del server di autorizzazione OAuth. Questo parametro è facoltativo. Il valore predefinito è $null. Deve essere specificato se AuthorizationScope specificato.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | 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. Questo parametro è facoltativo. Il valore predefinito è $null.
| Tipo: | String[] |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-Confirm
Richiede conferma prima di eseguire il cmdlet.
| Tipo: | SwitchParameter |
| Alias: | cf |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | False |
| Accettare caratteri jolly: | False |
-Context
Istanza di PsApiManagementContext. Questo parametro è obbligatorio.
| Tipo: | PsApiManagementContext |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-DefaultProfile
Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.
| Tipo: | IAzureContextContainer |
| Alias: | AzContext, AzureRmContext, AzureCredential |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | False |
| Accettare caratteri jolly: | False |
-Description
Descrizione dell'API Web. Questo parametro è facoltativo.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-InputObject
Istanza di PsApiManagementApi. Questo parametro è obbligatorio.
| Tipo: | PsApiManagementApi |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | True |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-Name
Nome API Web. Nome pubblico dell'API come apparirebbe nei portali di sviluppo e amministrazione. Questo parametro è obbligatorio.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-OpenIdProviderId
Identificatore del server di autorizzazione OpenId. Questo parametro è facoltativo. Il valore predefinito è $null. Deve essere specificato se è specificato BearerTokenSendingMethods.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-PassThru
Se specificato, l'istanza di Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiApi rappresenta l'API impostata.
| Tipo: | SwitchParameter |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-Path
Percorso API Web. Ultima parte dell'URL pubblico dell'API. Questo URL verrà usato dai consumer dell'API per l'invio di richieste al servizio Web. Deve essere lunga da 1 a 400 caratteri. Questo parametro è facoltativo. Il valore predefinito è $null.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-Protocols
Protocolli API Web (http, https). Protocolli su cui è disponibile l'API. Questo parametro è obbligatorio. Il valore predefinito è $null.
| Tipo: | PsApiManagementSchema[] |
| Valori accettati: | Http, Https |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-ServiceUrl
URL del servizio Web che espone l'API. Questo URL verrà usato solo da Gestione API di Azure e non verrà reso pubblico. Deve contenere da 1 a 2000 caratteri. Questo parametro è obbligatorio.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-SubscriptionKeyHeaderName
Nome dell'intestazione della chiave di sottoscrizione. Questo parametro è facoltativo. Il valore predefinito è $null.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-SubscriptionKeyQueryParamName
Nome del parametro della stringa di query della chiave di sottoscrizione. Questo parametro è facoltativo. Il valore predefinito è $null.
| Tipo: | String |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-SubscriptionRequired
Flag per applicare SubscriptionRequired per le richieste all'API. Questo parametro è facoltativo.
| Tipo: | SwitchParameter |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | True |
| Accettare caratteri jolly: | False |
-WhatIf
Mostra cosa accadrebbe se il cmdlet viene eseguito. Il cmdlet non viene eseguito.
| Tipo: | SwitchParameter |
| Alias: | wi |
| Posizione: | Named |
| Valore predefinito: | None |
| Necessario: | False |
| Accettare l'input della pipeline: | False |
| Accettare caratteri jolly: | False |
