GatewayHostnameConfigurations Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface GatewayHostnameConfigurations

Resource collection API of GatewayHostnameConfigurations.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new GatewayHostnameConfigurationContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String gatewayId, String hcId, String ifMatch) Deletes the specified hostname configuration from the specified Gateway.
abstract void	deleteById(String id) Deletes the specified hostname configuration from the specified Gateway.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes the specified hostname configuration from the specified Gateway.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String gatewayId, String hcId, String ifMatch, Context context) Deletes the specified hostname configuration from the specified Gateway.
abstract GatewayHostnameConfigurationContract	get(String resourceGroupName, String serviceName, String gatewayId, String hcId) Get details of a hostname configuration.
abstract GatewayHostnameConfigurationContract	getById(String id) Get details of a hostname configuration.
abstract Response<GatewayHostnameConfigurationContract>	getByIdWithResponse(String id, Context context) Get details of a hostname configuration.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String gatewayId, String hcId) Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.
abstract GatewayHostnameConfigurationsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String gatewayId, String hcId, Context context) Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.
abstract Response<GatewayHostnameConfigurationContract>	getWithResponse(String resourceGroupName, String serviceName, String gatewayId, String hcId, Context context) Get details of a hostname configuration.
abstract PagedIterable<GatewayHostnameConfigurationContract>	listByService(String resourceGroupName, String serviceName, String gatewayId) Lists the collection of hostname configurations for the specified gateway.
abstract PagedIterable<GatewayHostnameConfigurationContract>	listByService(String resourceGroupName, String serviceName, String gatewayId, String filter, Integer top, Integer skip, Context context) Lists the collection of hostname configurations for the specified gateway.

Method Details

define

public abstract GatewayHostnameConfigurationContract.DefinitionStages.Blank define(String name)

Begins definition for a new GatewayHostnameConfigurationContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new GatewayHostnameConfigurationContract definition.

delete

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

Deletes the specified hostname configuration from the specified 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'.

hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

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.

deleteById

public abstract void deleteById(String id)

Deletes the specified hostname configuration from the specified Gateway.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

Deletes the specified hostname configuration from the specified Gateway.

Parameters:

id - the resource ID.

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

deleteWithResponse

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

Deletes the specified hostname configuration from the specified 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'.

hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

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

get

public abstract GatewayHostnameConfigurationContract get(String resourceGroupName, String serviceName, String gatewayId, String hcId)

Get details of a hostname configuration.

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

hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

Returns:

details of a hostname configuration.

getById

public abstract GatewayHostnameConfigurationContract getById(String id)

Get details of a hostname configuration.

Parameters:

id - the resource ID.

Returns:

details of a hostname configuration.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Get details of a hostname configuration.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

details of a hostname configuration.

getEntityTag

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

Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.

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

hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

getEntityTagWithResponse

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

Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.

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

hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

context - The context to associate with this operation.

Returns:

the response.

getWithResponse

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

Get details of a hostname configuration.

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

hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

context - The context to associate with this operation.

Returns:

details of a hostname configuration.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String gatewayId)

Lists the collection of hostname configurations for the specified 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'.

Returns:

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

listByService

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

Lists the collection of hostname configurations for the specified 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'.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| hostname | 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 hostname configuration list representation as paginated response with PagedIterable<T>.