FirewallRules interface

Package:

@azure/arm-cosmosdbforpostgresql

Interface representing a FirewallRules.

Methods

beginCreateOrUpdate(string, string, string, FirewallRule, FirewallRulesCreateOrUpdateOptionalParams)	Creates a new cluster firewall rule or updates an existing cluster firewall rule.
beginCreateOrUpdateAndWait(string, string, string, FirewallRule, FirewallRulesCreateOrUpdateOptionalParams)	Creates a new cluster firewall rule or updates an existing cluster firewall rule.
beginDelete(string, string, string, FirewallRulesDeleteOptionalParams)	Deletes a cluster firewall rule.
beginDeleteAndWait(string, string, string, FirewallRulesDeleteOptionalParams)	Deletes a cluster firewall rule.
get(string, string, string, FirewallRulesGetOptionalParams)	Gets information about a cluster firewall rule.
listByCluster(string, string, FirewallRulesListByClusterOptionalParams)	Lists all the firewall rules on cluster.

Method Details

beginCreateOrUpdate(string, string, string, FirewallRule, FirewallRulesCreateOrUpdateOptionalParams)

Creates a new cluster firewall rule or updates an existing cluster firewall rule.

function beginCreateOrUpdate(resourceGroupName: string, clusterName: string, firewallRuleName: string, parameters: FirewallRule, options?: FirewallRulesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<FirewallRule>, FirewallRule>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

firewallRuleName

string

The name of the cluster firewall rule.

parameters

FirewallRule

The required parameters for creating or updating a firewall rule.

options

FirewallRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<FirewallRule>, FirewallRule>>

beginCreateOrUpdateAndWait(string, string, string, FirewallRule, FirewallRulesCreateOrUpdateOptionalParams)

Creates a new cluster firewall rule or updates an existing cluster firewall rule.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

firewallRuleName

string

The name of the cluster firewall rule.

parameters

FirewallRule

The required parameters for creating or updating a firewall rule.

options

FirewallRulesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<FirewallRule>

beginDelete(string, string, string, FirewallRulesDeleteOptionalParams)

Deletes a cluster firewall rule.

function beginDelete(resourceGroupName: string, clusterName: string, firewallRuleName: string, options?: FirewallRulesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<FirewallRulesDeleteHeaders>, FirewallRulesDeleteHeaders>>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

firewallRuleName

string

The name of the cluster firewall rule.

options

FirewallRulesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<FirewallRulesDeleteHeaders>, FirewallRulesDeleteHeaders>>

beginDeleteAndWait(string, string, string, FirewallRulesDeleteOptionalParams)

Deletes a cluster firewall rule.

function beginDeleteAndWait(resourceGroupName: string, clusterName: string, firewallRuleName: string, options?: FirewallRulesDeleteOptionalParams): Promise<FirewallRulesDeleteHeaders>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

firewallRuleName

string

The name of the cluster firewall rule.

options

FirewallRulesDeleteOptionalParams

The options parameters.

Returns

Promise<FirewallRulesDeleteHeaders>

get(string, string, string, FirewallRulesGetOptionalParams)

Gets information about a cluster firewall rule.

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

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

firewallRuleName

string

The name of the cluster firewall rule.

options

FirewallRulesGetOptionalParams

The options parameters.

Returns

Promise<FirewallRule>

listByCluster(string, string, FirewallRulesListByClusterOptionalParams)

Lists all the firewall rules on cluster.

function listByCluster(resourceGroupName: string, clusterName: string, options?: FirewallRulesListByClusterOptionalParams): PagedAsyncIterableIterator<FirewallRule, FirewallRule[], PageSettings>

Parameters

resourceGroupName

string

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

clusterName

string

The name of the cluster.

options

FirewallRulesListByClusterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<FirewallRule, FirewallRule[], PageSettings>