Compartilhar via


ServerAdministrators interface

Interface representing a ServerAdministrators.

Methods

beginCreateOrUpdate(string, string, ServerAdministratorResource, ServerAdministratorsCreateOrUpdateOptionalParams)

Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.

beginCreateOrUpdateAndWait(string, string, ServerAdministratorResource, ServerAdministratorsCreateOrUpdateOptionalParams)

Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.

beginDelete(string, string, ServerAdministratorsDeleteOptionalParams)

Deletes server active directory administrator.

beginDeleteAndWait(string, string, ServerAdministratorsDeleteOptionalParams)

Deletes server active directory administrator.

get(string, string, ServerAdministratorsGetOptionalParams)

Gets information about a AAD server administrator.

list(string, string, ServerAdministratorsListOptionalParams)

Returns a list of server Administrators.

Method Details

beginCreateOrUpdate(string, string, ServerAdministratorResource, ServerAdministratorsCreateOrUpdateOptionalParams)

Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, properties: ServerAdministratorResource, options?: ServerAdministratorsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ServerAdministratorResource>, ServerAdministratorResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

properties
ServerAdministratorResource

The required parameters for creating or updating an AAD server administrator.

options
ServerAdministratorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<ServerAdministratorResource>, ServerAdministratorResource>>

beginCreateOrUpdateAndWait(string, string, ServerAdministratorResource, ServerAdministratorsCreateOrUpdateOptionalParams)

Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, properties: ServerAdministratorResource, options?: ServerAdministratorsCreateOrUpdateOptionalParams): Promise<ServerAdministratorResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

properties
ServerAdministratorResource

The required parameters for creating or updating an AAD server administrator.

options
ServerAdministratorsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, ServerAdministratorsDeleteOptionalParams)

Deletes server active directory administrator.

function beginDelete(resourceGroupName: string, serverName: string, options?: ServerAdministratorsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServerAdministratorsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, ServerAdministratorsDeleteOptionalParams)

Deletes server active directory administrator.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, options?: ServerAdministratorsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServerAdministratorsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ServerAdministratorsGetOptionalParams)

Gets information about a AAD server administrator.

function get(resourceGroupName: string, serverName: string, options?: ServerAdministratorsGetOptionalParams): Promise<ServerAdministratorResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServerAdministratorsGetOptionalParams

The options parameters.

Returns

list(string, string, ServerAdministratorsListOptionalParams)

Returns a list of server Administrators.

function list(resourceGroupName: string, serverName: string, options?: ServerAdministratorsListOptionalParams): PagedAsyncIterableIterator<ServerAdministratorResource, ServerAdministratorResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options
ServerAdministratorsListOptionalParams

The options parameters.

Returns