ServerAzureADAdministratorsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:server_azure_ad_administrators> attribute.

Constructor

ServerAzureADAdministratorsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates an existing Azure Active Directory administrator.
begin_delete	Deletes the Azure Active Directory administrator with the given name.
get	Gets a Azure Active Directory administrator.
list_by_server	Gets a list of Azure Active Directory administrators in a server.

begin_create_or_update

Creates or updates an existing Azure Active Directory administrator.

async begin_create_or_update(resource_group_name: str, server_name: str, administrator_name: str | _models.AdministratorName, parameters: _models.ServerAzureADAdministrator, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ServerAzureADAdministrator]

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.
server_name Required	str The name of the server. Required.
administrator_name Required	str or AdministratorName The name of server active directory administrator. "ActiveDirectory" Required.
parameters Required	ServerAzureADAdministrator or IO[bytes] The requested Azure Active Directory administrator Resource state. Is either a ServerAzureADAdministrator type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the Azure Active Directory administrator with the given name.

async begin_delete(resource_group_name: str, server_name: str, administrator_name: str | AdministratorName, **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.
server_name Required	str The name of the server. Required.
administrator_name Required	str or AdministratorName The name of server active directory administrator. "ActiveDirectory" 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 Azure Active Directory administrator.

async get(resource_group_name: str, server_name: str, administrator_name: str | AdministratorName, **kwargs: Any) -> ServerAzureADAdministrator

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.
server_name Required	str The name of the server. Required.
administrator_name Required	str or AdministratorName The name of server active directory administrator. "ActiveDirectory" Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_server

Gets a list of Azure Active Directory administrators in a server.

list_by_server(resource_group_name: str, server_name: str, **kwargs: Any) -> AsyncItemPaged[ServerAzureADAdministrator]

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.
server_name Required	str The name of the server. Required.

Returns

Type	Description
AsyncItemPaged[ServerAzureADAdministrator]	An iterator like instance of either ServerAzureADAdministrator 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'>