IpFirewallRules interface

Package:

@azure/arm-synapse

Interface representing a IpFirewallRules.

Methods

beginCreateOrUpdate(string, string, string, IpFirewallRuleInfo, IpFirewallRulesCreateOrUpdateOptionalParams)	Creates or updates a firewall rule
beginCreateOrUpdateAndWait(string, string, string, IpFirewallRuleInfo, IpFirewallRulesCreateOrUpdateOptionalParams)	Creates or updates a firewall rule
beginDelete(string, string, string, IpFirewallRulesDeleteOptionalParams)	Deletes a firewall rule
beginDeleteAndWait(string, string, string, IpFirewallRulesDeleteOptionalParams)	Deletes a firewall rule
beginReplaceAll(string, string, ReplaceAllIpFirewallRulesRequest, IpFirewallRulesReplaceAllOptionalParams)	Replaces firewall rules
beginReplaceAllAndWait(string, string, ReplaceAllIpFirewallRulesRequest, IpFirewallRulesReplaceAllOptionalParams)	Replaces firewall rules
get(string, string, string, IpFirewallRulesGetOptionalParams)	Get a firewall rule
listByWorkspace(string, string, IpFirewallRulesListByWorkspaceOptionalParams)	Returns a list of firewall rules

Method Details

beginCreateOrUpdate(string, string, string, IpFirewallRuleInfo, IpFirewallRulesCreateOrUpdateOptionalParams)

Creates or updates a firewall rule

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, ruleName: string, ipFirewallRuleInfo: IpFirewallRuleInfo, options?: IpFirewallRulesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<IpFirewallRuleInfo>, IpFirewallRuleInfo>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

ruleName

string

The IP firewall rule name

ipFirewallRuleInfo

IpFirewallRuleInfo

IP firewall rule properties

options

IpFirewallRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<IpFirewallRuleInfo>, IpFirewallRuleInfo>>

beginCreateOrUpdateAndWait(string, string, string, IpFirewallRuleInfo, IpFirewallRulesCreateOrUpdateOptionalParams)

Creates or updates a firewall rule

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, ruleName: string, ipFirewallRuleInfo: IpFirewallRuleInfo, options?: IpFirewallRulesCreateOrUpdateOptionalParams): Promise<IpFirewallRuleInfo>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

ruleName

string

The IP firewall rule name

ipFirewallRuleInfo

IpFirewallRuleInfo

IP firewall rule properties

options

IpFirewallRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<IpFirewallRuleInfo>

beginDelete(string, string, string, IpFirewallRulesDeleteOptionalParams)

Deletes a firewall rule

function beginDelete(resourceGroupName: string, workspaceName: string, ruleName: string, options?: IpFirewallRulesDeleteOptionalParams): Promise<PollerLike<PollOperationState<IpFirewallRulesDeleteResponse>, IpFirewallRulesDeleteResponse>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

ruleName

string

The IP firewall rule name

options

IpFirewallRulesDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<IpFirewallRulesDeleteResponse>, IpFirewallRulesDeleteResponse>>

beginDeleteAndWait(string, string, string, IpFirewallRulesDeleteOptionalParams)

Deletes a firewall rule

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, ruleName: string, options?: IpFirewallRulesDeleteOptionalParams): Promise<IpFirewallRulesDeleteResponse>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

ruleName

string

The IP firewall rule name

options

IpFirewallRulesDeleteOptionalParams

The options parameters.

Returns

Promise<IpFirewallRulesDeleteResponse>

beginReplaceAll(string, string, ReplaceAllIpFirewallRulesRequest, IpFirewallRulesReplaceAllOptionalParams)

Replaces firewall rules

function beginReplaceAll(resourceGroupName: string, workspaceName: string, request: ReplaceAllIpFirewallRulesRequest, options?: IpFirewallRulesReplaceAllOptionalParams): Promise<PollerLike<PollOperationState<ReplaceAllFirewallRulesOperationResponse>, ReplaceAllFirewallRulesOperationResponse>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

request

ReplaceAllIpFirewallRulesRequest

Replace all IP firewall rules request

options

IpFirewallRulesReplaceAllOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<ReplaceAllFirewallRulesOperationResponse>, ReplaceAllFirewallRulesOperationResponse>>

beginReplaceAllAndWait(string, string, ReplaceAllIpFirewallRulesRequest, IpFirewallRulesReplaceAllOptionalParams)

Replaces firewall rules

function beginReplaceAllAndWait(resourceGroupName: string, workspaceName: string, request: ReplaceAllIpFirewallRulesRequest, options?: IpFirewallRulesReplaceAllOptionalParams): Promise<ReplaceAllFirewallRulesOperationResponse>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

request

ReplaceAllIpFirewallRulesRequest

Replace all IP firewall rules request

options

IpFirewallRulesReplaceAllOptionalParams

The options parameters.

Returns

Promise<ReplaceAllFirewallRulesOperationResponse>

get(string, string, string, IpFirewallRulesGetOptionalParams)

Get a firewall rule

function get(resourceGroupName: string, workspaceName: string, ruleName: string, options?: IpFirewallRulesGetOptionalParams): Promise<IpFirewallRuleInfo>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

ruleName

string

The IP firewall rule name

options

IpFirewallRulesGetOptionalParams

The options parameters.

Returns

Promise<IpFirewallRuleInfo>

listByWorkspace(string, string, IpFirewallRulesListByWorkspaceOptionalParams)

Returns a list of firewall rules

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: IpFirewallRulesListByWorkspaceOptionalParams): PagedAsyncIterableIterator<IpFirewallRuleInfo, IpFirewallRuleInfo[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options

IpFirewallRulesListByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IpFirewallRuleInfo, IpFirewallRuleInfo[], PageSettings>