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
’scheck_name_availability
attribute.-
execute
(name_availability_request: _models.NameAvailabilityRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailability[source]¶ -
execute
(name_availability_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.NameAvailability Check the availability of name for resource.
- Parameters
name_availability_request (NameAvailabilityRequest or IO) – The required parameters for checking if resource name is available. Is either a model type or a IO type. Required.
- Keyword Arguments
- Returns
NameAvailability or the result of cls(response)
- Return type
- Raises
-
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
’sconfigurations
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, configuration_name: str, parameters: _models.Configuration, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Configuration][source]¶ -
begin_create_or_update
(resource_group_name: str, server_name: str, configuration_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Configuration] Updates a configuration of a server.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
server_name (str) – The name of the server. Required.
configuration_name (str) – The name of the server configuration. Required.
parameters (Configuration or IO) – The required parameters for updating a server configuration. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Configuration or the result of cls(response)
- Return type
- Raises
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.Configuration][source]¶ List all the configurations in a given server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Configuration or the result of cls(response)
- Return type
- Raises
-
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
’sdatabases
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, parameters: _models.Database, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Database][source]¶ -
begin_create_or_update
(resource_group_name: str, server_name: str, database_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Database] 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. Required.
server_name (str) – The name of the server. Required.
database_name (str) – The name of the database. Required.
parameters (Database or IO) – The required parameters for creating or updating a database. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
- Keyword Arguments
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
- Raises
-
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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Database or the result of cls(response)
- Return type
- Raises
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.Database][source]¶ List all the databases in a given server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Database or the result of cls(response)
- Return type
- Raises
-
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
’sfirewall_rules
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: _models.FirewallRule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FirewallRule][source]¶ -
begin_create_or_update
(resource_group_name: str, server_name: str, firewall_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.FirewallRule] 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. Required.
server_name (str) – The name of the server. Required.
firewall_rule_name (str) – The name of the server firewall rule. Required.
parameters (FirewallRule or IO) – The required parameters for creating or updating a firewall rule. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
- Keyword Arguments
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
- Raises
-
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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
FirewallRule or the result of cls(response)
- Return type
- Raises
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.FirewallRule][source]¶ List all the firewall rules in a given server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either FirewallRule or the result of cls(response)
- Return type
- Raises
-
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
’slocation_based_performance_tier
attribute.-
list
(location_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.PerformanceTierProperties][source]¶ List all the performance tiers at specified location in a given subscription.
-
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
’slog_files
attribute.-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.LogFile][source]¶ List all the log files in a given server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either LogFile or the result of cls(response)
- Return type
- Raises
-
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
’soperations
attribute.-
list
(**kwargs: Any) → azure.mgmt.rdbms.postgresql.models._models_py3.OperationListResult[source]¶ Lists all of the available REST API operations.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
OperationListResult or the result of cls(response)
- Return type
- Raises
-
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
’sprivate_endpoint_connections
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: _models.PrivateEndpointConnection, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection][source]¶ -
begin_create_or_update
(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection] 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. Required.
server_name (str) – The name of the server. Required.
private_endpoint_connection_name (str) – Required.
parameters (PrivateEndpointConnection or IO) – Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
- Keyword Arguments
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
- Raises
-
begin_update_tags
(resource_group_name: str, server_name: str, private_endpoint_connection_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection] 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. Required.
server_name (str) – The name of the server. Required.
private_endpoint_connection_name (str) – Required.
parameters (TagsObject or IO) – Parameters supplied to the Update private endpoint connection Tags operation. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateEndpointConnection][source]¶ Gets all private endpoint connections on a server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PrivateEndpointConnection or the result of cls(response)
- Return type
- Raises
-
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
’sprivate_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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
PrivateLinkResource or the result of cls(response)
- Return type
- Raises
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.PrivateLinkResource][source]¶ Gets the private link resources for PostgreSQL server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PrivateLinkResource or the result of cls(response)
- Return type
- Raises
-
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
’srecoverable_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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
RecoverableServerResource or the result of cls(response)
- Return type
- Raises
-
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
’sreplicas
attribute.-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.Server][source]¶ List all the replicas for a given server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Server or the result of cls(response)
- Return type
- Raises
-
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
’sserver_administrators
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, properties: _models.ServerAdministratorResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerAdministratorResource][source]¶ -
begin_create_or_update
(resource_group_name: str, server_name: str, properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerAdministratorResource] 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. Required.
server_name (str) – The name of the server. Required.
properties (ServerAdministratorResource or IO) – The required parameters for creating or updating an AAD server administrator. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
begin_delete
(resource_group_name: str, server_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes server active directory administrator.
- Parameters
- Keyword Arguments
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
- Raises
-
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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServerAdministratorResource or the result of cls(response)
- Return type
- Raises
-
list
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerAdministratorResource][source]¶ Returns a list of server Administrators.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ServerAdministratorResource or the result of cls(response)
- Return type
- Raises
-
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
’sserver_based_performance_tier
attribute.-
list
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.PerformanceTierProperties][source]¶ List all the performance tiers for a PostgreSQL server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either PerformanceTierProperties or the result of cls(response)
- Return type
- Raises
-
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
’sserver_keys
attribute.-
begin_create_or_update
(server_name: str, key_name: str, resource_group_name: str, parameters: _models.ServerKey, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerKey][source]¶ -
begin_create_or_update
(server_name: str, key_name: str, resource_group_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerKey] Creates or updates a PostgreSQL Server key.
- Parameters
server_name (str) – The name of the server. Required.
key_name (str) – The name of the PostgreSQL Server key to be operated on (updated or created). Required.
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
parameters (ServerKey or IO) – The requested PostgreSQL Server key resource state. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
- Keyword Arguments
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
- Raises
-
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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServerKey or the result of cls(response)
- Return type
- Raises
-
list
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerKey][source]¶ Gets a list of Server keys.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ServerKey or the result of cls(response)
- Return type
- Raises
-
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
’sserver_parameters
attribute.-
begin_list_update_configurations
(resource_group_name: str, server_name: str, value: _models.ConfigurationListResult, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConfigurationListResult][source]¶ -
begin_list_update_configurations
(resource_group_name: str, server_name: str, value: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConfigurationListResult] 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. Required.
server_name (str) – The name of the server. Required.
value (ConfigurationListResult or IO) – The parameters for updating a list of server configuration. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
’sserver_security_alert_policies
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: _models.ServerSecurityAlertPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerSecurityAlertPolicy][source]¶ -
begin_create_or_update
(resource_group_name: str, server_name: str, security_alert_policy_name: Union[str, _models.SecurityAlertPolicyName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServerSecurityAlertPolicy] Creates or updates a threat detection policy.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
server_name (str) – The name of the server. Required.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the threat detection policy. “Default” Required.
parameters (ServerSecurityAlertPolicy or IO) – The server security alert policy. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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. Required.
server_name (str) – The name of the server. Required.
security_alert_policy_name (str or SecurityAlertPolicyName) – The name of the security alert policy. “Default” Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ServerSecurityAlertPolicy or the result of cls(response)
- Return type
- Raises
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.ServerSecurityAlertPolicy][source]¶ Get the server’s threat detection policies.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ServerSecurityAlertPolicy or the result of cls(response)
- Return type
- Raises
-
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
’sservers
attribute.-
begin_create
(resource_group_name: str, server_name: str, parameters: _models.ServerForCreate, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Server][source]¶ -
begin_create
(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Server] 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. Required.
server_name (str) – The name of the server. Required.
parameters (ServerForCreate or IO) – The required parameters for creating or updating a server. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
begin_delete
(resource_group_name: str, server_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Deletes a server.
- Parameters
- Keyword Arguments
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
- Raises
-
begin_restart
(resource_group_name: str, server_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶ Restarts a server.
- Parameters
- Keyword Arguments
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
- Raises
-
begin_update
(resource_group_name: str, server_name: str, parameters: _models.ServerUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Server][source]¶ -
begin_update
(resource_group_name: str, server_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Server] 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. Required.
server_name (str) – The name of the server. Required.
parameters (ServerUpdateParameters or IO) – The required parameters for updating a server. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
Server or the result of cls(response)
- Return type
- Raises
-
list
(**kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.Server][source]¶ List all the servers in a given subscription.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Server or the result of cls(response)
- Return type
- Raises
-
list_by_resource_group
(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.Server][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. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Server or the result of cls(response)
- Return type
- Raises
-
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
’svirtual_network_rules
attribute.-
begin_create_or_update
(resource_group_name: str, server_name: str, virtual_network_rule_name: str, parameters: _models.VirtualNetworkRule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkRule][source]¶ -
begin_create_or_update
(resource_group_name: str, server_name: str, virtual_network_rule_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkRule] Creates or updates an existing virtual network rule.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
server_name (str) – The name of the server. Required.
virtual_network_rule_name (str) – The name of the virtual network rule. Required.
parameters (VirtualNetworkRule or IO) – The requested virtual Network Rule Resource state. Is either a model type or a IO type. Required.
- Keyword Arguments
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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
- Raises
-
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
- Keyword Arguments
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
- Raises
-
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
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
-
list_by_server
(resource_group_name: str, server_name: str, **kwargs: Any) → Iterable[azure.mgmt.rdbms.postgresql.models._models_py3.VirtualNetworkRule][source]¶ Gets a list of virtual network rules in a server.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either VirtualNetworkRule or the result of cls(response)
- Return type
- Raises
-
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'>¶
-