ManagedInstanceKeysOperations Class

ManagedInstanceKeysOperations async 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

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 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: ManagedInstanceKey, **kwargs: Any) -> AsyncLROPoller[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.
managed_instance_name Required	str The name of the managed instance.
key_name Required	str The name of the managed instance key to be operated on (updated or created).
parameters Required	ManagedInstanceKey The requested managed instance 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 AsyncPollingMethod By default, your polling method will be AsyncARMPolling. 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
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.
managed_instance_name Required	str The name of the managed instance.
key_name Required	str The name of the managed instance key to be deleted.

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 AsyncPollingMethod By default, your polling method will be AsyncARMPolling. 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
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.
managed_instance_name Required	str The name of the managed instance.
key_name Required	str The name of the managed instance 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
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) -> AsyncIterable[ManagedInstanceKeyListResult]

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.
managed_instance_name Required	str The name of the managed instance.
filter	str An OData filter expression that filters elements in the collection. Default value: None

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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