Condividi tramite

ApiOperation interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Interfaccia che rappresenta un'ApiOperation.

Metodi

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

Crea una nuova operazione nell'API o ne aggiorna una esistente.
delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Elimina l'operazione specificata nell'API.
get(string, string, string, string, ApiOperationGetOptionalParams)

Ottiene i dettagli dell'operazione API specificata dal relativo identificatore.
getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) dell'operazione API specificata dal relativo identificatore.
listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Elenca una raccolta di operazioni per l'API specificata.
update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Aggiornamenti i dettagli dell'operazione nell'API specificata dal relativo identificatore.

Dettagli metodo

createOrUpdate(string, string, string, string, OperationContract, ApiOperationCreateOrUpdateOptionalParams)

Crea una nuova operazione nell'API o ne aggiorna una esistente.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, parameters: OperationContract, options?: ApiOperationCreateOrUpdateOptionalParams): Promise<ApiOperationCreateOrUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

parameters
OperationContract

Creare parametri.

options
ApiOperationCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiOperationCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiOperationDeleteOptionalParams)

Elimina l'operazione specificata nell'API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, options?: ApiOperationDeleteOptionalParams): Promise<void>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

options
ApiOperationDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, string, string, ApiOperationGetOptionalParams)

Ottiene i dettagli dell'operazione API specificata dal relativo identificatore.

function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetOptionalParams): Promise<ApiOperationGetResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options
ApiOperationGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiOperationGetResponse>

getEntityTag(string, string, string, string, ApiOperationGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) dell'operazione API specificata dal relativo identificatore.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationGetEntityTagOptionalParams): Promise<ApiOperationGetEntityTagHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options
ApiOperationGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiOperationGetEntityTagHeaders>

listByApi(string, string, string, ApiOperationListByApiOptionalParams)

Elenca una raccolta di operazioni per l'API specificata.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

options
ApiOperationListByApiOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<OperationContract, OperationContract[], PageSettings>

update(string, string, string, string, string, OperationUpdateContract, ApiOperationUpdateOptionalParams)

Aggiornamenti i dettagli dell'operazione nell'API specificata dal relativo identificatore.

function update(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: ApiOperationUpdateOptionalParams): Promise<ApiOperationUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;rev=n come suffisso dove n è il numero di revisione.

operationId

string

Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

parameters
OperationUpdateContract

Parametri dell'aggiornamento dell'operazione API.

options
ApiOperationUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiOperationUpdateResponse>