Condividi tramite

GatewayApi interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Interfaccia che rappresenta un gatewayApi.

Metodi

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

Aggiunge un'API al gateway specificato.
delete(string, string, string, string, GatewayApiDeleteOptionalParams)

Elimina l'API specificata dal gateway specificato.
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

Verifica che l'entità API specificata dall'identificatore sia associata all'entità Gateway.
listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Elenca una raccolta di API associate a un gateway.

Dettagli metodo

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

Aggiunge un'API al gateway specificato.

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>

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.

gatewayId

string

Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio di Gestione API. Non deve avere il valore 'managed'

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options
GatewayApiCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiContract>

delete(string, string, string, string, GatewayApiDeleteOptionalParams)

Elimina l'API specificata dal gateway specificato.

function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): 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.

gatewayId

string

Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio di Gestione API. Non deve avere il valore 'managed'

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options
GatewayApiDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

Verifica che l'entità API specificata dall'identificatore sia associata all'entità Gateway.

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>

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.

gatewayId

string

Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio di Gestione API. Non deve avere il valore 'managed'

apiId

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options
GatewayApiGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<GatewayApiGetEntityTagHeaders>

listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Elenca una raccolta di API associate a un gateway.

function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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.

gatewayId

string

Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio di Gestione API. Non deve avere il valore 'managed'

options
GatewayApiListByServiceOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>