ServerAzureADAdministratorsOperations Class

ServerAzureADAdministratorsOperations 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

ServerAzureADAdministratorsOperations

Constructor

ServerAzureADAdministratorsOperations(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 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.

begin_create_or_update(resource_group_name: str, server_name: str, administrator_name: str | '_models.AdministratorName', parameters: '_models.ServerAzureADAdministrator', **kwargs: Any) -> LROPoller['_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.
server_name Required	str The name of the server.
administrator_name Required	str or AdministratorName The name of server active directory administrator.
parameters Required	ServerAzureADAdministrator The requested Azure Active Directory administrator 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 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

Type	Description
LROPoller[ServerAzureADAdministrator]	An instance of LROPoller 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.

begin_delete(resource_group_name: str, server_name: str, administrator_name: str | '_models.AdministratorName', **kwargs: Any) -> LROPoller[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.
server_name Required	str The name of the server.
administrator_name Required	str or AdministratorName The name of server active directory administrator.

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

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

Exceptions

Type	Description
HttpResponseError

get

Gets a Azure Active Directory administrator.

get(resource_group_name: str, server_name: str, administrator_name: str | '_models.AdministratorName', **kwargs: Any) -> _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.
server_name Required	str The name of the server.
administrator_name Required	str or AdministratorName The name of server active directory administrator.

Keyword-Only Parameters

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

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) -> Iterable['_models.AdministratorListResult']

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

Keyword-Only Parameters

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

Returns

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