Gateway interface
Interface representing a Gateway.
Methods
Method Details
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Creates or updates a Gateway to be used in Api Management instance.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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
- GatewayContract
Gateway details.
The options parameters.
Returns
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Deletes specific Gateway.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- GatewayDeleteOptionalParams
The options parameters.
Returns
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Gets the Shared Access Authorization Token for the gateway.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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
- GatewayTokenRequestContract
Gateway token request contract properties.
The options parameters.
Returns
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Gets the details of the Gateway specified by its identifier.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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'
- options
- GatewayGetOptionalParams
The options parameters.
Returns
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the Gateway specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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'
The options parameters.
Returns
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Lists a collection of gateways registered with service instance.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
listKeys(string, string, string, GatewayListKeysOptionalParams)
Retrieves gateway keys.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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'
- options
- GatewayListKeysOptionalParams
The options parameters.
Returns
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Regenerates specified gateway key invalidating any tokens created with it.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Updates the details of the gateway specified by its identifier.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- GatewayUpdateOptionalParams
The options parameters.
Returns
Promise<GatewayUpdateResponse>