Backend interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa un back-end.

Métodos

createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)	Crea o actualiza un back-end.
delete(string, string, string, string, BackendDeleteOptionalParams)	Elimina el back-end especificado.
get(string, string, string, BackendGetOptionalParams)	Obtiene los detalles del back-end especificado por su identificador.
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)	Obtiene la versión de estado de entidad (Etag) del back-end especificado por su identificador.
listByService(string, string, BackendListByServiceOptionalParams)	Enumera una colección de back-end en la instancia de servicio especificada.
reconnect(string, string, string, BackendReconnectOptionalParams)	Notifica a la puerta de enlace de API Management que cree una nueva conexión al back-end después del tiempo de espera especificado. Si no se especificó ningún tiempo de espera, se usa el tiempo de espera de 2 minutos.
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)	Actualiza un back-end existente.

Detalles del método

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

Crea o actualiza un back-end.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

backendId

string

Identificador de la entidad back-end. Debe ser único en la instancia actual del servicio API Management.

parameters

BackendContract

Cree parámetros.

options

BackendCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<BackendCreateOrUpdateResponse>

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

Elimina el back-end especificado.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

backendId

string

Identificador de la entidad back-end. Debe ser único en la instancia actual del servicio API Management.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

options

BackendDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, string, BackendGetOptionalParams)

Obtiene los detalles del back-end especificado por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

backendId

string

Identificador de la entidad back-end. Debe ser único en la instancia actual del servicio API Management.

options

BackendGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<BackendGetResponse>

getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)

Obtiene la versión de estado de entidad (Etag) del back-end especificado por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

backendId

string

Identificador de la entidad back-end. Debe ser único en la instancia actual del servicio API Management.

options

BackendGetEntityTagOptionalParams

Parámetros de opciones.

Devoluciones

Promise<BackendGetEntityTagHeaders>

listByService(string, string, BackendListByServiceOptionalParams)

Enumera una colección de back-end en la instancia de servicio especificada.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

BackendListByServiceOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>

reconnect(string, string, string, BackendReconnectOptionalParams)

Notifica a la puerta de enlace de API Management que cree una nueva conexión al back-end después del tiempo de espera especificado. Si no se especificó ningún tiempo de espera, se usa el tiempo de espera de 2 minutos.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

backendId

string

Identificador de la entidad back-end. Debe ser único en la instancia actual del servicio API Management.

options

BackendReconnectOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Actualiza un back-end existente.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

backendId

string

Identificador de la entidad back-end. Debe ser único en la instancia actual del servicio API Management.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

parameters

BackendUpdateParameters

Actualice los parámetros.

options

BackendUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<BackendUpdateResponse>