GatewaysClient Interface

Package:

com.azure.resourcemanager.apimanagement.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface GatewaysClient

An instance of this class provides access to all the operations defined in GatewaysClient.

Method Summary

Modifier and Type	Method and Description
abstract GatewayContractInner	createOrUpdate(String resourceGroupName, String serviceName, String gatewayId, GatewayContractInner parameters) Creates or updates a Gateway to be used in Api Management instance.
abstract GatewaysCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String gatewayId, GatewayContractInner parameters, String ifMatch, Context context) Creates or updates a Gateway to be used in Api Management instance.
abstract void	delete(String resourceGroupName, String serviceName, String gatewayId, String ifMatch) Deletes specific Gateway.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String gatewayId, String ifMatch, Context context) Deletes specific Gateway.
abstract GatewayTokenContractInner	generateToken(String resourceGroupName, String serviceName, String gatewayId, GatewayTokenRequestContract parameters) Gets the Shared Access Authorization Token for the gateway.
abstract Response<GatewayTokenContractInner>	generateTokenWithResponse(String resourceGroupName, String serviceName, String gatewayId, GatewayTokenRequestContract parameters, Context context) Gets the Shared Access Authorization Token for the gateway.
abstract GatewayContractInner	get(String resourceGroupName, String serviceName, String gatewayId) Gets the details of the Gateway specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String gatewayId) Gets the entity state (Etag) version of the Gateway specified by its identifier.
abstract GatewaysGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String gatewayId, Context context) Gets the entity state (Etag) version of the Gateway specified by its identifier.
abstract GatewaysGetResponse	getWithResponse(String resourceGroupName, String serviceName, String gatewayId, Context context) Gets the details of the Gateway specified by its identifier.
abstract PagedIterable<GatewayContractInner>	listByService(String resourceGroupName, String serviceName) Lists a collection of gateways registered with service instance.
abstract PagedIterable<GatewayContractInner>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context) Lists a collection of gateways registered with service instance.
abstract GatewayKeysContractInner	listKeys(String resourceGroupName, String serviceName, String gatewayId) Retrieves gateway keys.
abstract GatewaysListKeysResponse	listKeysWithResponse(String resourceGroupName, String serviceName, String gatewayId, Context context) Retrieves gateway keys.
abstract void	regenerateKey(String resourceGroupName, String serviceName, String gatewayId, GatewayKeyRegenerationRequestContract parameters) Regenerates specified gateway key invalidating any tokens created with it.
abstract Response<Void>	regenerateKeyWithResponse(String resourceGroupName, String serviceName, String gatewayId, GatewayKeyRegenerationRequestContract parameters, Context context) Regenerates specified gateway key invalidating any tokens created with it.
abstract GatewayContractInner	update(String resourceGroupName, String serviceName, String gatewayId, String ifMatch, GatewayContractInner parameters) Updates the details of the gateway specified by its identifier.
abstract GatewaysUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, String gatewayId, String ifMatch, GatewayContractInner parameters, Context context) Updates the details of the gateway specified by its identifier.

Method Details

createOrUpdate

public abstract GatewayContractInner createOrUpdate(String resourceGroupName, String serviceName, String gatewayId, GatewayContractInner parameters)

Creates or updates a Gateway to be used in Api Management instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

parameters - Gateway details.

Returns:

gateway details.

createOrUpdateWithResponse

public abstract GatewaysCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String gatewayId, GatewayContractInner parameters, String ifMatch, Context context)

Creates or updates a Gateway to be used in Api Management instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

parameters - Gateway details.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

gateway details.

delete

public abstract void delete(String resourceGroupName, String serviceName, String gatewayId, String ifMatch)

Deletes specific Gateway.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

ifMatch - 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.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String gatewayId, String ifMatch, Context context)

Deletes specific Gateway.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

ifMatch - 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.

context - The context to associate with this operation.

Returns:

the Response<T>.

generateToken

public abstract GatewayTokenContractInner generateToken(String resourceGroupName, String serviceName, String gatewayId, GatewayTokenRequestContract parameters)

Gets the Shared Access Authorization Token for the gateway.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

parameters - Gateway token request contract properties.

Returns:

the Shared Access Authorization Token for the gateway.

generateTokenWithResponse

public abstract Response generateTokenWithResponse(String resourceGroupName, String serviceName, String gatewayId, GatewayTokenRequestContract parameters, Context context)

Gets the Shared Access Authorization Token for the gateway.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

parameters - Gateway token request contract properties.

context - The context to associate with this operation.

Returns:

the Shared Access Authorization Token for the gateway along with Response<T>.

get

public abstract GatewayContractInner get(String resourceGroupName, String serviceName, String gatewayId)

Gets the details of the Gateway specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

Returns:

the details of the Gateway specified by its identifier.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String gatewayId)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

getEntityTagWithResponse

public abstract GatewaysGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String gatewayId, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract GatewaysGetResponse getWithResponse(String resourceGroupName, String serviceName, String gatewayId, Context context)

Gets the details of the Gateway specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

context - The context to associate with this operation.

Returns:

the details of the Gateway specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists a collection of gateways registered with service instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

Returns:

paged Gateway list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Lists a collection of gateways registered with service instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Gateway list representation as paginated response with PagedIterable<T>.

listKeys

public abstract GatewayKeysContractInner listKeys(String resourceGroupName, String serviceName, String gatewayId)

Retrieves gateway keys.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

Returns:

gateway authentication keys.

listKeysWithResponse

public abstract GatewaysListKeysResponse listKeysWithResponse(String resourceGroupName, String serviceName, String gatewayId, Context context)

Retrieves gateway keys.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

context - The context to associate with this operation.

Returns:

gateway authentication keys.

regenerateKey

public abstract void regenerateKey(String resourceGroupName, String serviceName, String gatewayId, GatewayKeyRegenerationRequestContract parameters)

Regenerates specified gateway key invalidating any tokens created with it.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

parameters - Gateway key regeneration request contract properties.

regenerateKeyWithResponse

public abstract Response regenerateKeyWithResponse(String resourceGroupName, String serviceName, String gatewayId, GatewayKeyRegenerationRequestContract parameters, Context context)

Regenerates specified gateway key invalidating any tokens created with it.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

parameters - Gateway key regeneration request contract properties.

context - The context to associate with this operation.

Returns:

the Response<T>.

update

public abstract GatewayContractInner update(String resourceGroupName, String serviceName, String gatewayId, String ifMatch, GatewayContractInner parameters)

Updates the details of the gateway specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

ifMatch - 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 - Gateway details.

Returns:

gateway details.

updateWithResponse

public abstract GatewaysUpdateResponse updateWithResponse(String resourceGroupName, String serviceName, String gatewayId, String ifMatch, GatewayContractInner parameters, Context context)

Updates the details of the gateway specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

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

ifMatch - 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 - Gateway details.

context - The context to associate with this operation.

Returns:

gateway details.