Backend interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un back-end.

Metodi

createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)	Crea o aggiorna un back-end.
delete(string, string, string, string, BackendDeleteOptionalParams)	Elimina il back-end specificato.
get(string, string, string, BackendGetOptionalParams)	Ottiene i dettagli del back-end specificato dal relativo identificatore.
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) del back-end specificato dal relativo identificatore.
listByService(string, string, BackendListByServiceOptionalParams)	Elenca una raccolta di back-end nell'istanza del servizio specificata.
reconnect(string, string, string, BackendReconnectOptionalParams)	Notifica al gateway di Gestione API di creare una nuova connessione al back-end dopo il timeout specificato. Se non è stato specificato alcun timeout, viene usato il timeout di 2 minuti.
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)	Aggiorna un back-end esistente.

Dettagli metodo

createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)

Crea o aggiorna un back-end.

function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

backendId

string

Identificatore dell'entità back-end. Deve essere univoco nell'istanza corrente del servizio Gestione API.

parameters

BackendContract

Creare parametri.

options

BackendCreateOrUpdateOptionalParams

Parametri delle opzioni.

Valori restituiti

Promise<BackendCreateOrUpdateResponse>

delete(string, string, string, string, BackendDeleteOptionalParams)

Elimina il back-end specificato.

function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

backendId

string

Identificatore dell'entità back-end. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

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

options

BackendDeleteOptionalParams

Parametri delle opzioni.

Valori restituiti

Promise<void>

get(string, string, string, BackendGetOptionalParams)

Ottiene i dettagli del back-end specificato dal relativo identificatore.

function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

backendId

string

Identificatore dell'entità back-end. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

BackendGetOptionalParams

Parametri delle opzioni.

Valori restituiti

Promise<BackendGetResponse>

getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) del back-end specificato dal relativo identificatore.

function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

backendId

string

Identificatore dell'entità back-end. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

BackendGetEntityTagOptionalParams

Parametri delle opzioni.

Valori restituiti

Promise<BackendGetEntityTagHeaders>

listByService(string, string, BackendListByServiceOptionalParams)

Elenca una raccolta di back-end nell'istanza del servizio specificata.

function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

BackendListByServiceOptionalParams

Parametri delle opzioni.

Valori restituiti

PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

reconnect(string, string, string, BackendReconnectOptionalParams)

Notifica al gateway di Gestione API di creare una nuova connessione al back-end dopo il timeout specificato. Se non è stato specificato alcun timeout, viene usato il timeout di 2 minuti.

function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

backendId

string

Identificatore dell'entità back-end. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

BackendReconnectOptionalParams

Parametri delle opzioni.

Valori restituiti

Promise<void>

update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)

Aggiorna un back-end esistente.

function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

backendId

string

Identificatore dell'entità back-end. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

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

parameters

BackendUpdateParameters

Aggiornare i parametri.

options

BackendUpdateOptionalParams

Parametri delle opzioni.

Valori restituiti

Promise<BackendUpdateResponse>