Interface Administrators
public interface Administrators
Resource collection API of Administrators.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new ActiveDirectoryAdministrator resource.void
Deletes an Active Directory Administrator associated with the server.void
delete
(String resourceGroupName, String serverName, String objectId, com.azure.core.util.Context context) Deletes an Active Directory Administrator associated with the server.void
deleteById
(String id) Deletes an Active Directory Administrator associated with the server.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes an Active Directory Administrator associated with the server.Gets information about a server.Gets information about a server.com.azure.core.http.rest.Response<ActiveDirectoryAdministrator>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets information about a server.com.azure.core.http.rest.Response<ActiveDirectoryAdministrator>
getWithResponse
(String resourceGroupName, String serverName, String objectId, com.azure.core.util.Context context) Gets information about a server.com.azure.core.http.rest.PagedIterable<ActiveDirectoryAdministrator>
listByServer
(String resourceGroupName, String serverName) List all the AAD administrators for a given server.com.azure.core.http.rest.PagedIterable<ActiveDirectoryAdministrator>
listByServer
(String resourceGroupName, String serverName, com.azure.core.util.Context context) List all the AAD administrators for a given server.
-
Method Details
-
delete
Deletes an Active Directory Administrator associated with the server.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.objectId
- Guid of the objectId for the 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.
-
delete
void delete(String resourceGroupName, String serverName, String objectId, com.azure.core.util.Context context) Deletes an Active Directory Administrator associated with the server.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.objectId
- Guid of the objectId for the administrator.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.
-
getWithResponse
com.azure.core.http.rest.Response<ActiveDirectoryAdministrator> getWithResponse(String resourceGroupName, String serverName, String objectId, com.azure.core.util.Context context) Gets information about a server.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.objectId
- Guid of the objectId for the administrator.context
- The context to associate with this operation.- Returns:
- information about a server 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.
-
get
Gets information about a server.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.objectId
- Guid of the objectId for the administrator.- Returns:
- information about a 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.
-
listByServer
com.azure.core.http.rest.PagedIterable<ActiveDirectoryAdministrator> listByServer(String resourceGroupName, String serverName) List all the AAD administrators for a given server.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.- Returns:
- a list of active directory administrators as paginated response with
PagedIterable
. - 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.
-
listByServer
com.azure.core.http.rest.PagedIterable<ActiveDirectoryAdministrator> listByServer(String resourceGroupName, String serverName, com.azure.core.util.Context context) List all the AAD administrators for a given server.- 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:
- a list of active directory administrators as paginated response with
PagedIterable
. - 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.
-
getById
Gets information about a server.- Parameters:
id
- the resource ID.- Returns:
- information about a server 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<ActiveDirectoryAdministrator> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets information about a server.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- information about a server 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.
-
deleteById
Deletes an Active Directory Administrator associated with the server.- Parameters:
id
- the resource ID.- 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.
-
deleteByIdWithResponse
Deletes an Active Directory Administrator associated with the server.- Parameters:
id
- the resource ID.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.
-
define
Begins definition for a new ActiveDirectoryAdministrator resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new ActiveDirectoryAdministrator definition.
-