FirewallRulesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
CosmosdbForPostgresqlMgmtClient's
<xref:firewall_rules> attribute.
Constructor
FirewallRulesOperations(*args, **kwargs)Methods
| begin_create_or_update |
Creates a new cluster firewall rule or updates an existing cluster firewall rule. |
| begin_delete |
Deletes a cluster firewall rule. |
| get |
Gets information about a cluster firewall rule. |
| list_by_cluster |
Lists all the firewall rules on cluster. |
begin_create_or_update
Creates a new cluster firewall rule or updates an existing cluster firewall rule.
begin_create_or_update(resource_group_name: str, cluster_name: str, firewall_rule_name: str, parameters: _models.FirewallRule, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.FirewallRule]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
The name of the cluster. Required. |
|
firewall_rule_name
Required
|
The name of the cluster firewall rule. Required. |
|
parameters
Required
|
FirewallRule or
IO
The required parameters for creating or updating a firewall rule. Is either a FirewallRule type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either FirewallRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes a cluster firewall rule.
begin_delete(resource_group_name: str, cluster_name: str, firewall_rule_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
The name of the cluster. Required. |
|
firewall_rule_name
Required
|
The name of the cluster firewall rule. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets information about a cluster firewall rule.
get(resource_group_name: str, cluster_name: str, firewall_rule_name: str, **kwargs: Any) -> FirewallRuleParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
The name of the cluster. Required. |
|
firewall_rule_name
Required
|
The name of the cluster firewall rule. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
FirewallRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_cluster
Lists all the firewall rules on cluster.
list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) -> Iterable[FirewallRule]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
The name of the cluster. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either FirewallRule or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.cosmosdbforpostgresql.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv102\\Lib\\site-packages\\azure\\mgmt\\cosmosdbforpostgresql\\models\\__init__.py'>