ServerKeysOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:server_keys> attribute.
Constructor
ServerKeysOperations(*args, **kwargs)
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, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ServerKey]
Parameters
| Name | Description |
|---|---|
|
server_name
Required
|
The name of the server. Required. |
|
key_name
Required
|
The name of the PostgreSQL Server key to be operated on (updated or created). Required. |
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
parameters
Required
|
The requested PostgreSQL Server key resource state. Is either a ServerKey type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either ServerKey or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the server. Required. |
|
key_name
Required
|
The name of the PostgreSQL Server key to be deleted. Required. |
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a PostgreSQL Server key.
get(resource_group_name: str, server_name: str, key_name: str, **kwargs: Any) -> ServerKey
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
|
key_name
Required
|
The name of the PostgreSQL Server key to be retrieved. Required. |
Returns
| Type | Description |
|---|---|
|
ServerKey or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Gets a list of Server keys.
list(resource_group_name: str, server_name: str, **kwargs: Any) -> ItemPaged[ServerKey]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
server_name
Required
|
The name of the server. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ServerKey or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.rdbms.postgresql.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv198\\Lib\\site-packages\\azure\\mgmt\\rdbms\\postgresql\\models\\__init__.py'>