Package com.azure.resourcemanager.apimanagement.models

Interface GatewayHostnameConfigurations

public interface GatewayHostnameConfigurations

Resource collection API of GatewayHostnameConfigurations.

Method Summary

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

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<GatewayHostnameConfigurationContract> 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.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByService

com.azure.core.http.rest.PagedIterable<GatewayHostnameConfigurationContract> listByService(String resourceGroupName,
                                                                                           String serviceName,
                                                                                           String gatewayId,
                                                                                           String filter,
                                                                                           Integer top,
                                                                                           Integer skip,
                                                                                           com.azure.core.util.Context context)

Lists the collection of hostname configurations for the specified gateway.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTag

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.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntityTagWithResponse

GatewayHostnameConfigurationsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                                           String serviceName,
                                                                           String gatewayId,
                                                                           String hcId,
                                                                           com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

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

Get details of a hostname configuration.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<GatewayHostnameConfigurationContract> getWithResponse(String resourceGroupName,
                                                                                        String serviceName,
                                                                                        String gatewayId,
                                                                                        String hcId,
                                                                                        com.azure.core.util.Context context)

Get details of a hostname configuration.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

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.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String gatewayId,
                                                           String hcId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes the specified hostname configuration from the specified Gateway.

Parameters:

resourceGroupName - The name of the resource group.

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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getById

GatewayHostnameConfigurationContract getById(String id)

Get details of a hostname configuration.

Parameters:

id - the resource ID.

Returns:

details of a hostname configuration.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByIdWithResponse

com.azure.core.http.rest.Response<GatewayHostnameConfigurationContract> getByIdWithResponse(String id,
                                                                                            com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteById

void deleteById(String id)

Deletes the specified hostname configuration from the specified Gateway.

Parameters:

id - the resource ID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               String ifMatch,
                                                               com.azure.core.util.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.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

define

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.