FirewallRules interface

Package:

@azure/arm-sql

Interface representing a FirewallRules.

Methods

createOrUpdate(string, string, string, FirewallRule, FirewallRulesCreateOrUpdateOptionalParams)	Creates or updates a firewall rule.
delete(string, string, string, FirewallRulesDeleteOptionalParams)	Deletes a firewall rule.
get(string, string, string, FirewallRulesGetOptionalParams)	Gets a firewall rule.
listByServer(string, string, FirewallRulesListByServerOptionalParams)	Gets a list of firewall rules.
replace(string, string, FirewallRuleList, FirewallRulesReplaceOptionalParams)	Replaces all firewall rules on the server.

Method Details

createOrUpdate(string, string, string, FirewallRule, FirewallRulesCreateOrUpdateOptionalParams)

Creates or updates a firewall rule.

function createOrUpdate(resourceGroupName: string, serverName: string, firewallRuleName: string, parameters: FirewallRule, options?: FirewallRulesCreateOrUpdateOptionalParams): Promise<FirewallRule>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

firewallRuleName

string

The name of the firewall rule.

parameters

FirewallRule

The required parameters for creating or updating a firewall rule.

options

FirewallRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<FirewallRule>

delete(string, string, string, FirewallRulesDeleteOptionalParams)

Deletes a firewall rule.

function delete(resourceGroupName: string, serverName: string, firewallRuleName: string, options?: FirewallRulesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

firewallRuleName

string

The name of the firewall rule.

options

FirewallRulesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, FirewallRulesGetOptionalParams)

Gets a firewall rule.

function get(resourceGroupName: string, serverName: string, firewallRuleName: string, options?: FirewallRulesGetOptionalParams): Promise<FirewallRule>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

firewallRuleName

string

The name of the firewall rule.

options

FirewallRulesGetOptionalParams

The options parameters.

Returns

Promise<FirewallRule>

listByServer(string, string, FirewallRulesListByServerOptionalParams)

Gets a list of firewall rules.

function listByServer(resourceGroupName: string, serverName: string, options?: FirewallRulesListByServerOptionalParams): PagedAsyncIterableIterator<FirewallRule, FirewallRule[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options

FirewallRulesListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FirewallRule, FirewallRule[], PageSettings>

replace(string, string, FirewallRuleList, FirewallRulesReplaceOptionalParams)

Replaces all firewall rules on the server.

function replace(resourceGroupName: string, serverName: string, parameters: FirewallRuleList, options?: FirewallRulesReplaceOptionalParams): Promise<FirewallRule>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

parameters

FirewallRuleList

A list of server firewall rules.

options

FirewallRulesReplaceOptionalParams

The options parameters.

Returns

Promise<FirewallRule>