Package com.azure.resourcemanager.synapse.models

Interface IpFirewallRules

public interface IpFirewallRules

Resource collection API of IpFirewallRules.

Method Summary

Modifier and Type	Method	Description
IpFirewallRuleInfo.DefinitionStages.Blank	define(String name)	Begins definition for a new IpFirewallRuleInfo resource.
Object	delete(String resourceGroupName, String workspaceName, String ruleName)	Deletes a firewall rule.
Object	delete(String resourceGroupName, String workspaceName, String ruleName, com.azure.core.util.Context context)	Deletes a firewall rule.
Object	deleteById(String id)	Deletes a firewall rule.
Object	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a firewall rule.
IpFirewallRuleInfo	get(String resourceGroupName, String workspaceName, String ruleName)	Get a firewall rule.
IpFirewallRuleInfo	getById(String id)	Get a firewall rule.
com.azure.core.http.rest.Response<IpFirewallRuleInfo>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get a firewall rule.
com.azure.core.http.rest.Response<IpFirewallRuleInfo>	getWithResponse(String resourceGroupName, String workspaceName, String ruleName, com.azure.core.util.Context context)	Get a firewall rule.
com.azure.core.http.rest.PagedIterable<IpFirewallRuleInfo>	listByWorkspace(String resourceGroupName, String workspaceName)	Returns a list of firewall rules.
com.azure.core.http.rest.PagedIterable<IpFirewallRuleInfo>	listByWorkspace(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Returns a list of firewall rules.
ReplaceAllFirewallRulesOperationResponse	replaceAll(String resourceGroupName, String workspaceName, ReplaceAllIpFirewallRulesRequest request)	Replaces firewall rules.
ReplaceAllFirewallRulesOperationResponse	replaceAll(String resourceGroupName, String workspaceName, ReplaceAllIpFirewallRulesRequest request, com.azure.core.util.Context context)	Replaces firewall rules.

Method Detail

listByWorkspace

com.azure.core.http.rest.PagedIterable<IpFirewallRuleInfo> listByWorkspace(String resourceGroupName,
                                                                           String workspaceName)

Returns a list of firewall rules.

Parameters:

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

workspaceName - The name of the workspace.

Returns:

list of IP firewall rules 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.

listByWorkspace

com.azure.core.http.rest.PagedIterable<IpFirewallRuleInfo> listByWorkspace(String resourceGroupName,
                                                                           String workspaceName,
                                                                           com.azure.core.util.Context context)

Returns a list of firewall rules.

Parameters:

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

workspaceName - The name of the workspace.

context - The context to associate with this operation.

Returns:

list of IP firewall rules 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.

delete

Object delete(String resourceGroupName,
              String workspaceName,
              String ruleName)

Deletes a firewall rule.

Parameters:

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

workspaceName - The name of the workspace.

ruleName - The IP firewall rule name.

Returns:

any object.

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

Object delete(String resourceGroupName,
              String workspaceName,
              String ruleName,
              com.azure.core.util.Context context)

Deletes a firewall rule.

Parameters:

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

workspaceName - The name of the workspace.

ruleName - The IP firewall rule name.

context - The context to associate with this operation.

Returns:

any object.

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

IpFirewallRuleInfo get(String resourceGroupName,
                       String workspaceName,
                       String ruleName)

Get a firewall rule.

Parameters:

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

workspaceName - The name of the workspace.

ruleName - The IP firewall rule name.

Returns:

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

getWithResponse

com.azure.core.http.rest.Response<IpFirewallRuleInfo> getWithResponse(String resourceGroupName,
                                                                      String workspaceName,
                                                                      String ruleName,
                                                                      com.azure.core.util.Context context)

Get a firewall rule.

Parameters:

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

workspaceName - The name of the workspace.

ruleName - The IP firewall rule name.

context - The context to associate with this operation.

Returns:

a firewall rule 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.

replaceAll

ReplaceAllFirewallRulesOperationResponse replaceAll(String resourceGroupName,
                                                    String workspaceName,
                                                    ReplaceAllIpFirewallRulesRequest request)

Replaces firewall rules.

Parameters:

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

workspaceName - The name of the workspace.

request - Replace all IP firewall rules request.

Returns:

an existing operation for replacing the firewall rules.

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.

replaceAll

ReplaceAllFirewallRulesOperationResponse replaceAll(String resourceGroupName,
                                                    String workspaceName,
                                                    ReplaceAllIpFirewallRulesRequest request,
                                                    com.azure.core.util.Context context)

Replaces firewall rules.

Parameters:

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

workspaceName - The name of the workspace.

request - Replace all IP firewall rules request.

context - The context to associate with this operation.

Returns:

an existing operation for replacing the firewall rules.

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

IpFirewallRuleInfo getById(String id)

Get a firewall rule.

Parameters:

id - the resource ID.

Returns:

a firewall rule 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<IpFirewallRuleInfo> getByIdWithResponse(String id,
                                                                          com.azure.core.util.Context context)

Get a firewall rule.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a firewall rule 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

Object deleteById(String id)

Deletes a firewall rule.

Parameters:

id - the resource ID.

Returns:

any object.

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

Object deleteByIdWithResponse(String id,
                              com.azure.core.util.Context context)

Deletes a firewall rule.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

any object.

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

IpFirewallRuleInfo.DefinitionStages.Blank define(String name)

Begins definition for a new IpFirewallRuleInfo resource.

Parameters:

name - resource name.

Returns:

the first stage of the new IpFirewallRuleInfo definition.