Gateway interface
Interfaz que representa una puerta de enlace.
Métodos
Detalles del método
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Crea o actualiza una puerta de enlace que se usará en la instancia de Api Management.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
- parameters
- GatewayContract
Detalles de la puerta de enlace.
Parámetros de opciones.
Devoluciones
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Elimina una puerta de enlace específica.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
- 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
- GatewayDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Obtiene el token de autorización de acceso compartido para la puerta de enlace.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
- parameters
- GatewayTokenRequestContract
Propiedades del contrato de solicitud de token de puerta de enlace.
Parámetros de opciones.
Devoluciones
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Obtiene los detalles de la puerta de enlace especificada por su identificador.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
- options
- GatewayGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Obtiene la versión del estado de entidad (Etag) de la puerta de enlace especificada por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
Parámetros de opciones.
Devoluciones
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Muestra una colección de las puertas de enlace registradas con la instancia de servicio
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
Parámetros de opciones.
Devoluciones
listKeys(string, string, string, GatewayListKeysOptionalParams)
Recupera las claves de la puerta de enlace.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
- options
- GatewayListKeysOptionalParams
Parámetros de opciones.
Devoluciones
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Regenera la clave de puerta de enlace especificada que invalida los tokens creados con ella.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
- parameters
- GatewayKeyRegenerationRequestContract
Propiedades del contrato de solicitud de regeneración de claves de puerta de enlace.
Parámetros de opciones.
Devoluciones
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Novedades los detalles de la puerta de enlace especificada por su identificador.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
- serviceName
-
string
Nombre del servicio API Management.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia de servicio API Management actual. No debe tener el valor "administrado".
- 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
- GatewayContract
Detalles de la puerta de enlace.
- options
- GatewayUpdateOptionalParams
Parámetros de opciones.
Devoluciones
Promise<GatewayUpdateResponse>