Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Gateway

Package version

Interface representing a Gateway.

Hierarchy

  • Gateway

Implemented by

Index

Methods

Methods

createOrUpdate

delete

  • delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>

  • Deletes specific Gateway.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • gatewayId: string

      Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

    • ifMatch: string

      ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

    • Optional options: GatewayDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

generateToken

get

  • Gets the details of the Gateway specified by its identifier.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • gatewayId: string

      Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

    • Optional options: GatewayGetOptionalParams

      The options parameters.

    Returns Promise<GatewayGetResponse>

getEntityTag

  • Gets the entity state (Etag) version of the Gateway specified by its identifier.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • gatewayId: string

      Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

    • Optional options: GatewayGetEntityTagOptionalParams

      The options parameters.

    Returns Promise<GatewayGetEntityTagResponse>

listByService

listKeys

  • Retrieves gateway keys.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • gatewayId: string

      Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

    • Optional options: GatewayListKeysOptionalParams

      The options parameters.

    Returns Promise<GatewayListKeysResponse>

regenerateKey

  • Regenerates specified gateway key invalidating any tokens created with it.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • gatewayId: string

      Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

    • parameters: GatewayKeyRegenerationRequestContract

      Gateway key regeneration request contract properties.

    • Optional options: GatewayRegenerateKeyOptionalParams

      The options parameters.

    Returns Promise<void>

update

  • Updates the details of the gateway specified by its identifier.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • gatewayId: string

      Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

    • ifMatch: string

      ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

    • parameters: GatewayContract

      Gateway details.

    • Optional options: GatewayUpdateOptionalParams

      The options parameters.

    Returns Promise<GatewayUpdateResponse>

Generated using TypeDoc