Package com.azure.resourcemanager.dnsresolver.models

Interface ForwardingRules

public interface ForwardingRules

Resource collection API of ForwardingRules.

Method Summary

Modifier and Type	Method	Description
ForwardingRule.DefinitionStages.Blank	define(String name)	Begins definition for a new ForwardingRule resource.
void	delete(String resourceGroupName, String dnsForwardingRulesetName, String forwardingRuleName)	Deletes a forwarding rule in a DNS forwarding ruleset.
void	deleteById(String id)	Deletes a forwarding rule in a DNS forwarding ruleset.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)	Deletes a forwarding rule in a DNS forwarding ruleset.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String dnsForwardingRulesetName, String forwardingRuleName, String ifMatch, com.azure.core.util.Context context)	Deletes a forwarding rule in a DNS forwarding ruleset.
ForwardingRule	get(String resourceGroupName, String dnsForwardingRulesetName, String forwardingRuleName)	Gets properties of a forwarding rule in a DNS forwarding ruleset.
ForwardingRule	getById(String id)	Gets properties of a forwarding rule in a DNS forwarding ruleset.
com.azure.core.http.rest.Response<ForwardingRule>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets properties of a forwarding rule in a DNS forwarding ruleset.
com.azure.core.http.rest.Response<ForwardingRule>	getWithResponse(String resourceGroupName, String dnsForwardingRulesetName, String forwardingRuleName, com.azure.core.util.Context context)	Gets properties of a forwarding rule in a DNS forwarding ruleset.
com.azure.core.http.rest.PagedIterable<ForwardingRule>	list(String resourceGroupName, String dnsForwardingRulesetName)	Lists forwarding rules in a DNS forwarding ruleset.
com.azure.core.http.rest.PagedIterable<ForwardingRule>	list(String resourceGroupName, String dnsForwardingRulesetName, Integer top, com.azure.core.util.Context context)	Lists forwarding rules in a DNS forwarding ruleset.

Method Detail

delete

void delete(String resourceGroupName,
            String dnsForwardingRulesetName,
            String forwardingRuleName)

Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.

Parameters:

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

dnsForwardingRulesetName - The name of the DNS forwarding ruleset.

forwardingRuleName - The name of the forwarding rule.

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 dnsForwardingRulesetName,
                                                           String forwardingRuleName,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.

Parameters:

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

dnsForwardingRulesetName - The name of the DNS forwarding ruleset.

forwardingRuleName - The name of the forwarding rule.

ifMatch - ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

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

ForwardingRule get(String resourceGroupName,
                   String dnsForwardingRulesetName,
                   String forwardingRuleName)

Gets properties of a forwarding rule in a DNS forwarding ruleset.

Parameters:

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

dnsForwardingRulesetName - The name of the DNS forwarding ruleset.

forwardingRuleName - The name of the forwarding rule.

Returns:

properties of a forwarding rule in a DNS forwarding ruleset.

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<ForwardingRule> getWithResponse(String resourceGroupName,
                                                                  String dnsForwardingRulesetName,
                                                                  String forwardingRuleName,
                                                                  com.azure.core.util.Context context)

Gets properties of a forwarding rule in a DNS forwarding ruleset.

Parameters:

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

dnsForwardingRulesetName - The name of the DNS forwarding ruleset.

forwardingRuleName - The name of the forwarding rule.

context - The context to associate with this operation.

Returns:

properties of a forwarding rule in a DNS forwarding ruleset along with 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.

list

com.azure.core.http.rest.PagedIterable<ForwardingRule> list(String resourceGroupName,
                                                            String dnsForwardingRulesetName)

Lists forwarding rules in a DNS forwarding ruleset.

Parameters:

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

dnsForwardingRulesetName - The name of the DNS forwarding ruleset.

Returns:

the response to an enumeration operation on forwarding rules within a DNS forwarding ruleset 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.

list

com.azure.core.http.rest.PagedIterable<ForwardingRule> list(String resourceGroupName,
                                                            String dnsForwardingRulesetName,
                                                            Integer top,
                                                            com.azure.core.util.Context context)

Lists forwarding rules in a DNS forwarding ruleset.

Parameters:

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

dnsForwardingRulesetName - The name of the DNS forwarding ruleset.

top - The maximum number of results to return. If not specified, returns up to 100 results.

context - The context to associate with this operation.

Returns:

the response to an enumeration operation on forwarding rules within a DNS forwarding ruleset 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.

getById

ForwardingRule getById(String id)

Gets properties of a forwarding rule in a DNS forwarding ruleset.

Parameters:

id - the resource ID.

Returns:

properties of a forwarding rule in a DNS forwarding ruleset along with 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.

getByIdWithResponse

com.azure.core.http.rest.Response<ForwardingRule> getByIdWithResponse(String id,
                                                                      com.azure.core.util.Context context)

Gets properties of a forwarding rule in a DNS forwarding ruleset.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a forwarding rule in a DNS forwarding ruleset along with 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.

deleteById

void deleteById(String id)

Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.

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 a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.

Parameters:

id - the resource ID.

ifMatch - ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

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

ForwardingRule.DefinitionStages.Blank define(String name)

Begins definition for a new ForwardingRule resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ForwardingRule definition.