ManagedInstanceKeysOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:managed_instance_keys> attribute.

Constructor

ManagedInstanceKeysOperations(*args, **kwargs)

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.

async begin_create_or_update(resource_group_name: str, managed_instance_name: str, key_name: str, parameters: _models.ManagedInstanceKey, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ManagedInstanceKey]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
managed_instance_name Required	str The name of the managed instance. Required.
key_name Required	str The name of the managed instance key to be operated on (updated or created). Required.
parameters Required	ManagedInstanceKey or IO[bytes] The requested managed instance key resource state. Is either a ManagedInstanceKey type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the managed instance key with the given name.

async begin_delete(resource_group_name: str, managed_instance_name: str, key_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
managed_instance_name Required	str The name of the managed instance. Required.
key_name Required	str The name of the managed instance key to be deleted. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Gets a managed instance key.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
managed_instance_name Required	str The name of the managed instance. Required.
key_name Required	str The name of the managed instance key to be retrieved. Required.

Returns

Type	Description
ManagedInstanceKey	ManagedInstanceKey or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_instance

Gets a list of managed instance keys.

list_by_instance(resource_group_name: str, managed_instance_name: str, filter: str | None = None, **kwargs: Any) -> AsyncItemPaged[ManagedInstanceKey]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
managed_instance_name Required	str The name of the managed instance. Required.
filter	str An OData filter expression that filters elements in the collection. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>