azure.mgmt.rdbms.postgresql.operations module

class azure.mgmt.rdbms.postgresql.operations.CheckNameAvailabilityOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s check_name_availability attribute.

execute(name_availability_request: azure.mgmt.rdbms.postgresql.models._models_py3.NameAvailabilityRequest, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.NameAvailability[source]

Check the availability of name for resource.

Parameters

name_availability_request (NameAvailabilityRequest) – The required parameters for checking if resource name is available.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

NameAvailability, or the result of cls(response)

Return type

NameAvailability

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.ConfigurationsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s configurations attribute.

begin_create_or_update(resource_group_name: str, server_name: str, configuration_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.Configuration, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.Configuration][source]

Updates a configuration of a server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • configuration_name (str) – The name of the server configuration.

  • parameters (Configuration) – The required parameters for updating a server configuration.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Configuration or the result of cls(response)

Return type

LROPoller[Configuration]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, configuration_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.Configuration[source]

Gets information about a configuration of server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • configuration_name (str) – The name of the server configuration.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

Configuration, or the result of cls(response)

Return type

Configuration

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ConfigurationListResult][source]

List all the configurations in a given server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ConfigurationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.DatabasesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s databases attribute.

begin_create_or_update(resource_group_name: str, server_name: str, database_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.Database, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.Database][source]

Creates a new database or updates an existing database.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • database_name (str) – The name of the database.

  • parameters (Database) – The required parameters for creating or updating a database.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Database or the result of cls(response)

Return type

LROPoller[Database]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any)azure.core.polling._poller.LROPoller[None][source]

Deletes a database.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • database_name (str) – The name of the database.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, database_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.Database[source]

Gets information about a database.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • database_name (str) – The name of the database.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

Database, or the result of cls(response)

Return type

Database

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.DatabaseListResult][source]

List all the databases in a given server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[DatabaseListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.FirewallRulesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s firewall_rules attribute.

begin_create_or_update(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.FirewallRule, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.FirewallRule][source]

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

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • firewall_rule_name (str) – The name of the server firewall rule.

  • parameters (FirewallRule) – The required parameters for creating or updating a firewall rule.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[FirewallRule]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any)azure.core.polling._poller.LROPoller[None][source]

Deletes a server firewall rule.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • firewall_rule_name (str) – The name of the server firewall rule.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, firewall_rule_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.FirewallRule[source]

Gets information about a server firewall rule.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • firewall_rule_name (str) – The name of the server firewall rule.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

FirewallRule, or the result of cls(response)

Return type

FirewallRule

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.FirewallRuleListResult][source]

List all the firewall rules in a given server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[FirewallRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.LocationBasedPerformanceTierOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s location_based_performance_tier attribute.

list(location_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.PerformanceTierListResult][source]

List all the performance tiers at specified location in a given subscription.

Parameters

location_name (str) – The name of the location.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PerformanceTierListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.LogFilesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s log_files attribute.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.LogFileListResult][source]

List all the log files in a given server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[LogFileListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s operations attribute.

list(**kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.OperationListResult[source]

Lists all of the available REST API operations.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

OperationListResult, or the result of cls(response)

Return type

OperationListResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s private_endpoint_connections attribute.

begin_create_or_update(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.PrivateEndpointConnection, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateEndpointConnection][source]

Approve or reject a private endpoint connection with a given name.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • private_endpoint_connection_name (str) –

  • parameters (PrivateEndpointConnection) –

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2018-06-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response)

Return type

LROPoller[PrivateEndpointConnection]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any)azure.core.polling._poller.LROPoller[None][source]

Deletes a private endpoint connection with a given name.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • private_endpoint_connection_name (str) –

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2018-06-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_update_tags(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.TagsObject, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateEndpointConnection][source]

Updates tags on private endpoint connection.

Updates private endpoint connection with the specified tags.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • private_endpoint_connection_name (str) –

  • parameters (TagsObject) – Parameters supplied to the Update private endpoint connection Tags operation.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2018-06-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response)

Return type

LROPoller[PrivateEndpointConnection]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.PrivateEndpointConnection[source]

Gets a private endpoint connection.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2018-06-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnection, or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateEndpointConnectionListResult][source]

Gets all private endpoint connections on a server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2018-06-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PrivateEndpointConnectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s private_link_resources attribute.

get(resource_group_name: str, server_name: str, group_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.PrivateLinkResource[source]

Gets a private link resource for PostgreSQL server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • group_name (str) – The name of the private link resource.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2018-06-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateLinkResource, or the result of cls(response)

Return type

PrivateLinkResource

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateLinkResourceListResult][source]

Gets the private link resources for PostgreSQL server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2018-06-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PrivateLinkResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.RecoverableServersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s recoverable_servers attribute.

get(resource_group_name: str, server_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.RecoverableServerResource[source]

Gets a recoverable PostgreSQL Server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

RecoverableServerResource, or the result of cls(response)

Return type

RecoverableServerResource

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.ReplicasOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s replicas attribute.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerListResult][source]

List all the replicas for a given server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ServerListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.ServerAdministratorsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s server_administrators attribute.

begin_create_or_update(resource_group_name: str, server_name: str, properties: azure.mgmt.rdbms.postgresql.models._models_py3.ServerAdministratorResource, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.ServerAdministratorResource][source]

Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • properties (ServerAdministratorResource) – The required parameters for creating or updating an AAD server administrator.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerAdministratorResource or the result of cls(response)

Return type

LROPoller[ServerAdministratorResource]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, **kwargs: Any)azure.core.polling._poller.LROPoller[None][source]

Deletes server active directory administrator.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.ServerAdministratorResource[source]

Gets information about a AAD server administrator.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerAdministratorResource, or the result of cls(response)

Return type

ServerAdministratorResource

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerAdministratorResourceListResult][source]

Returns a list of server Administrators.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ServerAdministratorResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.ServerBasedPerformanceTierOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s server_based_performance_tier attribute.

list(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.PerformanceTierListResult][source]

List all the performance tiers for a PostgreSQL server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[PerformanceTierListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.ServerKeysOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s server_keys attribute.

begin_create_or_update(server_name: str, key_name: str, resource_group_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.ServerKey, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.ServerKey][source]

Creates or updates a PostgreSQL Server key.

Parameters
  • server_name (str) – The name of the server.

  • key_name (str) – The name of the PostgreSQL Server key to be operated on (updated or created).

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • parameters (ServerKey) – The requested PostgreSQL Server key resource state.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2020-01-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerKey or the result of cls(response)

Return type

LROPoller[ServerKey]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(server_name: str, key_name: str, resource_group_name: str, **kwargs: Any)azure.core.polling._poller.LROPoller[None][source]

Deletes the PostgreSQL Server key with the given name.

Parameters
  • server_name (str) – The name of the server.

  • key_name (str) – The name of the PostgreSQL Server key to be deleted.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2020-01-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, key_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.ServerKey[source]

Gets a PostgreSQL Server key.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • key_name (str) – The name of the PostgreSQL Server key to be retrieved.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2020-01-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerKey, or the result of cls(response)

Return type

ServerKey

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerKeyListResult][source]

Gets a list of Server keys.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2020-01-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ServerKeyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.ServerParametersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s server_parameters attribute.

begin_list_update_configurations(resource_group_name: str, server_name: str, value: azure.mgmt.rdbms.postgresql.models._models_py3.ConfigurationListResult, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.ConfigurationListResult][source]

Update a list of configurations in a given server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • value (ConfigurationListResult) – The parameters for updating a list of server configuration.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ConfigurationListResult or the result of cls(response)

Return type

LROPoller[ConfigurationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.ServerSecurityAlertPoliciesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s server_security_alert_policies attribute.

begin_create_or_update(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, azure.mgmt.rdbms.postgresql.models._postgre_sql_management_client_enums.SecurityAlertPolicyName], parameters: azure.mgmt.rdbms.postgresql.models._models_py3.ServerSecurityAlertPolicy, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.ServerSecurityAlertPolicy][source]

Creates or updates a threat detection policy.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the threat detection policy.

  • parameters (ServerSecurityAlertPolicy) – The server security alert policy.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ServerSecurityAlertPolicy or the result of cls(response)

Return type

LROPoller[ServerSecurityAlertPolicy]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, azure.mgmt.rdbms.postgresql.models._postgre_sql_management_client_enums.SecurityAlertPolicyName], **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.ServerSecurityAlertPolicy[source]

Get a server’s security alert policy.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

ServerSecurityAlertPolicy, or the result of cls(response)

Return type

ServerSecurityAlertPolicy

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerSecurityAlertPolicyListResult][source]

Get the server’s threat detection policies.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ServerSecurityAlertPolicyListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.ServersOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s servers attribute.

begin_create(resource_group_name: str, server_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.ServerForCreate, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.Server][source]

Creates a new server, or will overwrite an existing server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • parameters (ServerForCreate) – The required parameters for creating or updating a server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Server or the result of cls(response)

Return type

LROPoller[Server]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, **kwargs: Any)azure.core.polling._poller.LROPoller[None][source]

Deletes a server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_restart(resource_group_name: str, server_name: str, **kwargs: Any)azure.core.polling._poller.LROPoller[None][source]

Restarts a server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

begin_update(resource_group_name: str, server_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.ServerUpdateParameters, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.Server][source]

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • parameters (ServerUpdateParameters) – The required parameters for updating a server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Server or the result of cls(response)

Return type

LROPoller[Server]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.Server[source]

Gets information about a server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

Server, or the result of cls(response)

Return type

Server

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerListResult][source]

List all the servers in a given subscription.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ServerListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerListResult][source]

List all the servers in a given resource group.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ServerListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>
class azure.mgmt.rdbms.postgresql.operations.VirtualNetworkRulesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PostgreSQLManagementClient’s virtual_network_rules attribute.

begin_create_or_update(resource_group_name: str, server_name: str, virtual_network_rule_name: str, parameters: azure.mgmt.rdbms.postgresql.models._models_py3.VirtualNetworkRule, **kwargs: Any)azure.core.polling._poller.LROPoller[azure.mgmt.rdbms.postgresql.models._models_py3.VirtualNetworkRule][source]

Creates or updates an existing virtual network rule.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • virtual_network_rule_name (str) – The name of the virtual network rule.

  • parameters (VirtualNetworkRule) – The requested virtual Network Rule Resource state.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either VirtualNetworkRule or the result of cls(response)

Return type

LROPoller[VirtualNetworkRule]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, server_name: str, virtual_network_rule_name: str, **kwargs: Any)azure.core.polling._poller.LROPoller[None][source]

Deletes the virtual network rule with the given name.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • virtual_network_rule_name (str) – The name of the virtual network rule.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • 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 PollingMethod) – 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 (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, server_name: str, virtual_network_rule_name: str, **kwargs: Any)azure.mgmt.rdbms.postgresql.models._models_py3.VirtualNetworkRule[source]

Gets a virtual network rule.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

  • virtual_network_rule_name (str) – The name of the virtual network rule.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

VirtualNetworkRule, or the result of cls(response)

Return type

VirtualNetworkRule

Raises

~azure.core.exceptions.HttpResponseError

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any)Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.VirtualNetworkRuleListResult][source]

Gets a list of virtual network rules in a server.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • server_name (str) – The name of the server.

Keyword Arguments
  • api_version (str) – Api Version. Default value is “2017-12-01”. Note that overriding this default value may result in unsupported behavior.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[VirtualNetworkRuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.rdbms.postgresql.models' from '/mnt/vss/_work/1/s/sdk/rdbms/azure-mgmt-rdbms/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/rdbms/postgresql/models/__init__.py'>