Administrators interface
Interface representing a Administrators.
Methods
| begin |
Creates a new server. |
| begin |
Creates a new server. |
| begin |
Deletes an Active Directory Administrator associated with the server. |
| begin |
Deletes an Active Directory Administrator associated with the server. |
| get(string, string, string, Administrators |
Gets information about a server. |
| list |
List all the AAD administrators for a given server. |
Method Details
beginCreate(string, string, string, ActiveDirectoryAdministratorAdd, AdministratorsCreateOptionalParams)
Creates a new server.
function beginCreate(resourceGroupName: string, serverName: string, objectId: string, parameters: ActiveDirectoryAdministratorAdd, options?: AdministratorsCreateOptionalParams): Promise<SimplePollerLike<OperationState<ActiveDirectoryAdministrator>, ActiveDirectoryAdministrator>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Guid of the objectId for the administrator.
- parameters
- ActiveDirectoryAdministratorAdd
The required parameters for adding an active directory administrator for a server.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ActiveDirectoryAdministrator>, ActiveDirectoryAdministrator>>
beginCreateAndWait(string, string, string, ActiveDirectoryAdministratorAdd, AdministratorsCreateOptionalParams)
Creates a new server.
function beginCreateAndWait(resourceGroupName: string, serverName: string, objectId: string, parameters: ActiveDirectoryAdministratorAdd, options?: AdministratorsCreateOptionalParams): Promise<ActiveDirectoryAdministrator>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Guid of the objectId for the administrator.
- parameters
- ActiveDirectoryAdministratorAdd
The required parameters for adding an active directory administrator for a server.
The options parameters.
Returns
Promise<ActiveDirectoryAdministrator>
beginDelete(string, string, string, AdministratorsDeleteOptionalParams)
Deletes an Active Directory Administrator associated with the server.
function beginDelete(resourceGroupName: string, serverName: string, objectId: string, options?: AdministratorsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Guid of the objectId for the administrator.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, AdministratorsDeleteOptionalParams)
Deletes an Active Directory Administrator associated with the server.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, objectId: string, options?: AdministratorsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Guid of the objectId for the administrator.
The options parameters.
Returns
Promise<void>
get(string, string, string, AdministratorsGetOptionalParams)
Gets information about a server.
function get(resourceGroupName: string, serverName: string, objectId: string, options?: AdministratorsGetOptionalParams): Promise<ActiveDirectoryAdministrator>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Guid of the objectId for the administrator.
- options
- AdministratorsGetOptionalParams
The options parameters.
Returns
Promise<ActiveDirectoryAdministrator>
listByServer(string, string, AdministratorsListByServerOptionalParams)
List all the AAD administrators for a given server.
function listByServer(resourceGroupName: string, serverName: string, options?: AdministratorsListByServerOptionalParams): PagedAsyncIterableIterator<ActiveDirectoryAdministrator, ActiveDirectoryAdministrator[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
The options parameters.