Package com.azure.resourcemanager.mysql.models

Interface ServerAdministrators

public interface ServerAdministrators

Resource collection API of ServerAdministrators.

Method Summary

Modifier and Type	Method	Description
ServerAdministratorResource	createOrUpdate(String resourceGroupName, String serverName, ServerAdministratorResourceInner properties)	Creates or update active directory administrator on an existing server.
ServerAdministratorResource	createOrUpdate(String resourceGroupName, String serverName, ServerAdministratorResourceInner properties, com.azure.core.util.Context context)	Creates or update active directory administrator on an existing server.
void	delete(String resourceGroupName, String serverName, com.azure.core.util.Context context)	Deletes server active directory administrator.
void	deleteByResourceGroup(String resourceGroupName, String serverName)	Deletes server active directory administrator.
ServerAdministratorResource	get(String resourceGroupName, String serverName)	Gets information about a AAD server administrator.
com.azure.core.http.rest.Response<ServerAdministratorResource>	getWithResponse(String resourceGroupName, String serverName, com.azure.core.util.Context context)	Gets information about a AAD server administrator.
com.azure.core.http.rest.PagedIterable<ServerAdministratorResource>	list(String resourceGroupName, String serverName)	Returns a list of server Administrators.
com.azure.core.http.rest.PagedIterable<ServerAdministratorResource>	list(String resourceGroupName, String serverName, com.azure.core.util.Context context)	Returns a list of server Administrators.

Method Detail

get

ServerAdministratorResource get(String resourceGroupName,
                                String serverName)

Gets information about a AAD server administrator.

Parameters:

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

serverName - The name of the server.

Returns:

information about a AAD server administrator.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getWithResponse

com.azure.core.http.rest.Response<ServerAdministratorResource> getWithResponse(String resourceGroupName,
                                                                               String serverName,
                                                                               com.azure.core.util.Context context)

Gets information about a AAD server administrator.

Parameters:

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

serverName - The name of the server.

context - The context to associate with this operation.

Returns:

information about a AAD server administrator along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

ServerAdministratorResource createOrUpdate(String resourceGroupName,
                                           String serverName,
                                           ServerAdministratorResourceInner properties)

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

Parameters:

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

serverName - The name of the server.

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

Returns:

represents a and external administrator to be created.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

ServerAdministratorResource createOrUpdate(String resourceGroupName,
                                           String serverName,
                                           ServerAdministratorResourceInner properties,
                                           com.azure.core.util.Context context)

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

Parameters:

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

serverName - The name of the server.

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

context - The context to associate with this operation.

Returns:

represents a and external administrator to be created.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String serverName)

Deletes server active directory administrator.

Parameters:

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

serverName - The name of the server.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String serverName,
            com.azure.core.util.Context context)

Deletes server active directory administrator.

Parameters:

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

serverName - The name of the server.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ServerAdministratorResource> list(String resourceGroupName,
                                                                         String serverName)

Returns a list of server Administrators.

Parameters:

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

serverName - The name of the server.

Returns:

the response to a list Active Directory Administrators request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<ServerAdministratorResource> list(String resourceGroupName,
                                                                         String serverName,
                                                                         com.azure.core.util.Context context)

Returns a list of server Administrators.

Parameters:

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

serverName - The name of the server.

context - The context to associate with this operation.

Returns:

the response to a list Active Directory Administrators request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.