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

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

models

Alias to model classes used in this operation group.

Methods

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

begin_create_or_update

Creates or updates a server key.

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

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

key_name

str

Required

The name of the server key to be operated on (updated or created). The key name is required to be in the format of 'vault_key_version'. For example, if the keyId is https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name should be formatted as: YourVaultName_YourKeyName_YourKeyVersion.

parameters

ServerKey

Required

The requested server key resource state.

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]

Exceptions

HttpResponseError

begin_delete

Deletes the server key with the given name.

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

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

key_name

str

Required

The name of the server key to be deleted.

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]

Exceptions

HttpResponseError

get

Gets a server key.

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

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

key_name

str

Required

The name of the server key to be retrieved.

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

Exceptions

HttpResponseError

list_by_server

Gets a list of server keys.

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

Parameters

resource_group_name

str

Required

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

server_name

str

Required

The name of the server.

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]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>