Set-AzApiManagementOperation
Imposta i dettagli dell'operazione API.
Sintassi
Set-AzApiManagementOperation
-Context <PsApiManagementContext>
-ApiId <String>
[-ApiRevision <String>]
-OperationId <String>
-Name <String>
-Method <String>
-UrlTemplate <String>
[-Description <String>]
[-TemplateParameters <PsApiManagementParameter[]>]
[-Request <PsApiManagementRequest>]
[-Responses <PsApiManagementResponse[]>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Descrizione
Il cmdlet Set-AzApiManagementOperation imposta i dettagli dell'operazione API.
Esempio
Esempio 1: Impostare i dettagli dell'operazione
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementOperation -Context $apimContext -ApiId $APIID -OperationId $OperationId -Name "Get Resource" -Method GET -UrlTemplate "/newresource" -Description "Use this operation to get newresource"
Questo comando imposta i dettagli dell'operazione per la gestione API.
Esempio 2
Imposta i dettagli dell'operazione API. (generato automaticamente)
Set-AzApiManagementOperation -ApiId '0001' -Context <PsApiManagementContext> -Method 'GET' -Name 'ContosoApi' -OperationId 'Operation003' -UrlTemplate '/newresource'
Parametri
-ApiId
Specifica l'identificatore dell'API.
Tipo: | String |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | True |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-ApiRevision
Identificatore della revisione API. Questo parametro è facoltativo. Se non specificato, l'operazione verrà aggiornata nella revisione api attualmente attiva.
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
Specifica un'istanza di PsApiManagementContext.
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
Specifica la descrizione della nuova operazione.
Tipo: | String |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | False |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-Method
Specifica il metodo HTTP della nuova operazione.
Tipo: | String |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | True |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-Name
Specifica il nome visualizzato della nuova operazione.
Tipo: | String |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | True |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-OperationId
Specifica l'identificatore dell'operazione esistente.
Tipo: | String |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | True |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-PassThru
passthru
Tipo: | SwitchParameter |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | False |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-Request
Specifica i dettagli della richiesta di operazione.
Tipo: | PsApiManagementRequest |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | False |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-Responses
Specifica una matrice di possibili risposte all'operazione.
Tipo: | PsApiManagementResponse[] |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | False |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-TemplateParameters
Specifica una matrice o parametri definiti nel parametro UrlTemplate. Se non si specifica un valore, verrà generato un valore predefinito in base all'UrlTemplate. Usare il parametro per fornire altri dettagli sui parametri, ad esempio descrizione, tipo e altri valori possibili.
Tipo: | PsApiManagementParameter[] |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | False |
Accettare l'input della pipeline: | True |
Accettare caratteri jolly: | False |
-UrlTemplate
Specifica il modello di URL. Ad esempio: customers/{cid}/orders/{oid}/?date={date}.
Tipo: | String |
Posizione: | Named |
Valore predefinito: | None |
Necessario: | True |
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 |