FirewallRulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:firewall_rules> attribute.

Constructor

FirewallRulesOperations(*args, **kwargs)

Methods

create_or_update	Creates or updates a firewall rule.
delete	Deletes a firewall rule.
get	Gets a firewall rule.
list_by_server	Gets a list of firewall rules.
replace	Replaces all firewall rules on the server.

create_or_update

Creates or updates a firewall rule.

async create_or_update(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: _models.FirewallRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FirewallRule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
firewall_rule_name Required	str The name of the firewall rule. Required.
parameters Required	FirewallRule or IO[bytes] The required parameters for creating or updating a firewall rule. Is either a FirewallRule type or a IO[bytes] type. Required.

Returns

Type	Description
FirewallRule	FirewallRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a firewall rule.

async delete(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
firewall_rule_name Required	str The name of the firewall rule. Required.

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a firewall rule.

async get(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) -> FirewallRule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
firewall_rule_name Required	str The name of the firewall rule. Required.

Returns

Type	Description
FirewallRule	FirewallRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_server

Gets a list of firewall rules.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncItemPaged[FirewallRule]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.

Returns

Type	Description
AsyncItemPaged[FirewallRule]	An iterator like instance of either FirewallRule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

replace

Replaces all firewall rules on the server.

async replace(resource_group_name: str, server_name: str, parameters: _models.FirewallRuleList, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FirewallRule | None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
parameters Required	FirewallRuleList or IO[bytes] Is either a FirewallRuleList type or a IO[bytes] type. Required.

Returns

Type	Description
FirewallRule, None	FirewallRule or None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>