ManagedInstanceKeysOperations Class

ManagedInstanceKeysOperations 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

ManagedInstanceKeysOperations

Constructor

ManagedInstanceKeysOperations(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 managed instance key.
begin_delete	Deletes the managed instance key with the given name.
get	Gets a managed instance key.
list_by_instance	Gets a list of managed instance keys.

begin_create_or_update

Creates or updates a managed instance key.

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

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.

managed_instance_name

str

Required

The name of the managed instance.

key_name

str

Required

The name of the managed instance key to be operated on (updated or created).

parameters

ManagedInstanceKey

Required

The requested managed instance 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 ManagedInstanceKey or the result of cls(response)

Return type

LROPoller[ManagedInstanceKey]

Exceptions

HttpResponseError

begin_delete

Deletes the managed instance key with the given name.

begin_delete(resource_group_name: str, managed_instance_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.

managed_instance_name

str

Required

The name of the managed instance.

key_name

str

Required

The name of the managed instance 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 managed instance key.

get(resource_group_name: str, managed_instance_name: str, key_name: str, **kwargs: Any) -> _models.ManagedInstanceKey

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.

managed_instance_name

str

Required

The name of the managed instance.

key_name

str

Required

The name of the managed instance key to be retrieved.

cls

callable

A custom type or function that will be passed the direct response

Returns

ManagedInstanceKey, or the result of cls(response)

Return type

ManagedInstanceKey

Exceptions

HttpResponseError

list_by_instance

Gets a list of managed instance keys.

list_by_instance(resource_group_name: str, managed_instance_name: str, filter: Optional[str] = None, **kwargs: Any) -> Iterable[_models.ManagedInstanceKeyListResult]

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.

managed_instance_name

str

Required

The name of the managed instance.

filter

str

default value: None

An OData filter expression that filters elements in the collection.

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ManagedInstanceKeyListResult]

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'>