Interface AzureADAdministrators
public interface AzureADAdministrators
Resource collection API of AzureADAdministrators.
-
Method Summary
Modifier and TypeMethodDescriptiondefine
(AdministratorName name) Begins definition for a new AzureADAdministrator resource.void
delete
(String resourceGroupName, String serverName, AdministratorName administratorName) Deletes an Azure AD Administrator.void
delete
(String resourceGroupName, String serverName, AdministratorName administratorName, com.azure.core.util.Context context) Deletes an Azure AD Administrator.void
deleteById
(String id) Deletes an Azure AD Administrator.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes an Azure AD Administrator.get
(String resourceGroupName, String serverName, AdministratorName administratorName) Gets information about an azure ad administrator.Gets information about an azure ad administrator.com.azure.core.http.rest.Response<AzureADAdministrator>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets information about an azure ad administrator.com.azure.core.http.rest.Response<AzureADAdministrator>
getWithResponse
(String resourceGroupName, String serverName, AdministratorName administratorName, com.azure.core.util.Context context) Gets information about an azure ad administrator.com.azure.core.http.rest.PagedIterable<AzureADAdministrator>
listByServer
(String resourceGroupName, String serverName) List all the AAD administrators in a given server.com.azure.core.http.rest.PagedIterable<AzureADAdministrator>
listByServer
(String resourceGroupName, String serverName, com.azure.core.util.Context context) List all the AAD administrators in a given server.
-
Method Details
-
delete
Deletes an Azure AD Administrator.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.administratorName
- The name of the Azure AD 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, AdministratorName administratorName, com.azure.core.util.Context context) Deletes an Azure AD Administrator.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.administratorName
- The name of the Azure AD 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<AzureADAdministrator> getWithResponse(String resourceGroupName, String serverName, AdministratorName administratorName, com.azure.core.util.Context context) Gets information about an azure ad administrator.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.administratorName
- The name of the Azure AD Administrator.context
- The context to associate with this operation.- Returns:
- information about an azure ad 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.
-
get
AzureADAdministrator get(String resourceGroupName, String serverName, AdministratorName administratorName) Gets information about an azure ad administrator.- Parameters:
resourceGroupName
- The name of the resource group. The name is case insensitive.serverName
- The name of the server.administratorName
- The name of the Azure AD Administrator.- Returns:
- information about an azure ad 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.
-
listByServer
com.azure.core.http.rest.PagedIterable<AzureADAdministrator> listByServer(String resourceGroupName, String serverName) List all the AAD administrators in 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 azure ad 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<AzureADAdministrator> listByServer(String resourceGroupName, String serverName, com.azure.core.util.Context context) List all the AAD administrators in 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 azure ad 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 an azure ad administrator.- Parameters:
id
- the resource ID.- Returns:
- information about an azure ad 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<AzureADAdministrator> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets information about an azure ad administrator.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- information about an azure ad 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.
-
deleteById
Deletes an Azure AD Administrator.- 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 Azure AD Administrator.- 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 AzureADAdministrator resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new AzureADAdministrator definition.
-