ServerKeysOperations Class

ServerKeysOperations operations.

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

Inheritance

builtins.object

ServerKeysOperations

Constructor

ServerKeysOperations(client, config, serializer, deserializer)

Parameters

Name	Description
client Required	Client for service requests.
config Required	Configuration of service client.
serializer Required	An object model serializer.
deserializer Required	An object model deserializer.

Variables

Name	Description
models	Alias to model classes used in this operation group.

Methods

begin_create_or_update	Creates or updates a PostgreSQL Server key.
begin_delete	Deletes the PostgreSQL Server key with the given name.
get	Gets a PostgreSQL Server key.
list	Gets a list of Server keys.

begin_create_or_update

Creates or updates a PostgreSQL Server key.

begin_create_or_update(server_name: str, key_name: str, resource_group_name: str, parameters: '_models.ServerKey', **kwargs: Any) -> LROPoller['_models.ServerKey']

Parameters

Name	Description
server_name Required	str The name of the server.
key_name Required	str The name of the PostgreSQL Server key to be operated on (updated or created).
resource_group_name Required	str The name of the resource group. The name is case insensitive.
parameters Required	ServerKey The requested PostgreSQL Server key resource state.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or 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

Type	Description
LROPoller[ServerKey]	An instance of LROPoller that returns either ServerKey or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the PostgreSQL Server key with the given name.

begin_delete(server_name: str, key_name: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
server_name Required	str The name of the server.
key_name Required	str The name of the PostgreSQL Server key to be deleted.
resource_group_name Required	str The name of the resource group. The name is case insensitive.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or 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

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a PostgreSQL Server key.

get(resource_group_name: str, server_name: str, key_name: str, **kwargs: Any) -> _models.ServerKey

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
server_name Required	str The name of the server.
key_name Required	str The name of the PostgreSQL Server key to be retrieved.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ServerKey	ServerKey, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets a list of Server keys.

list(resource_group_name: str, server_name: str, **kwargs: Any) -> Iterable['_models.ServerKeyListResult']

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive.
server_name Required	str The name of the server.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.rdbms.postgresql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\rdbms\\postgresql\\models\\__init__.py'>