Share via

FirewallRulesOperations Class

FirewallRulesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Constructor

FirewallRulesOperations(client, config, serializer, deserializer)

Parameters

Name Description
client
Required

Client for service requests.
config
Required

Configuration of service client.
serializer
Required

An object model serializer.
deserializer
Required

An object model deserializer.

Variables

Name Description
models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

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

Deletes a firewall rule.
get

Gets information about a server firewall rule.
list_by_server

List all the firewall rules in a given server.

begin_create_or_update

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

async begin_create_or_update(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: FirewallRule, **kwargs: Any) -> AsyncLROPoller[FirewallRule]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
server_name
Required
str

The name of the server.
firewall_rule_name
Required
str

The name of the server firewall rule.
parameters
Required
FirewallRule

The required parameters for creating or updating a firewall rule.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
AsyncLROPoller[FirewallRule]

An instance of AsyncLROPoller that returns either FirewallRule or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes a firewall rule.

async begin_delete(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
server_name
Required
str

The name of the server.
firewall_rule_name
Required
str

The name of the server firewall rule.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets information about a server 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. The name is case insensitive.
server_name
Required
str

The name of the server.
firewall_rule_name
Required
str

The name of the server firewall rule.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
FirewallRule

FirewallRule, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_server

List all the firewall rules in a given server.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncIterable[FirewallRuleListResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive.
server_name
Required
str

The name of the server.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
AsyncItemPaged[FirewallRuleListResult]

An iterator like instance of either FirewallRuleListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.rdbms.mysql_flexibleservers.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv197\\Lib\\site-packages\\azure\\mgmt\\rdbms\\mysql_flexibleservers\\models\\__init__.py'>