ServerAzureADAdministrators interface
Interface representing a ServerAzureADAdministrators.
Methods
| begin |
Creates or updates an existing Azure Active Directory administrator. |
| begin |
Creates or updates an existing Azure Active Directory administrator. |
| begin |
Deletes the Azure Active Directory administrator with the given name. |
| begin |
Deletes the Azure Active Directory administrator with the given name. |
| get(string, string, string, Server |
Gets a Azure Active Directory administrator. |
| list |
Gets a list of Azure Active Directory administrators in a server. |
Method Details
beginCreateOrUpdate(string, string, string, ServerAzureADAdministrator, ServerAzureADAdministratorsCreateOrUpdateOptionalParams)
Creates or updates an existing Azure Active Directory administrator.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, administratorName: string, parameters: ServerAzureADAdministrator, options?: ServerAzureADAdministratorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServerAzureADAdministrator>, ServerAzureADAdministrator>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- administratorName
-
string
The name of server active directory administrator.
- parameters
- ServerAzureADAdministrator
The requested Azure Active Directory administrator Resource state.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServerAzureADAdministrator>, ServerAzureADAdministrator>>
beginCreateOrUpdateAndWait(string, string, string, ServerAzureADAdministrator, ServerAzureADAdministratorsCreateOrUpdateOptionalParams)
Creates or updates an existing Azure Active Directory administrator.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, administratorName: string, parameters: ServerAzureADAdministrator, options?: ServerAzureADAdministratorsCreateOrUpdateOptionalParams): Promise<ServerAzureADAdministrator>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- administratorName
-
string
The name of server active directory administrator.
- parameters
- ServerAzureADAdministrator
The requested Azure Active Directory administrator Resource state.
The options parameters.
Returns
Promise<ServerAzureADAdministrator>
beginDelete(string, string, string, ServerAzureADAdministratorsDeleteOptionalParams)
Deletes the Azure Active Directory administrator with the given name.
function beginDelete(resourceGroupName: string, serverName: string, administratorName: string, options?: ServerAzureADAdministratorsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- administratorName
-
string
The name of server active directory administrator.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ServerAzureADAdministratorsDeleteOptionalParams)
Deletes the Azure Active Directory administrator with the given name.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, administratorName: string, options?: ServerAzureADAdministratorsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- administratorName
-
string
The name of server active directory administrator.
The options parameters.
Returns
Promise<void>
get(string, string, string, ServerAzureADAdministratorsGetOptionalParams)
Gets a Azure Active Directory administrator.
function get(resourceGroupName: string, serverName: string, administratorName: string, options?: ServerAzureADAdministratorsGetOptionalParams): Promise<ServerAzureADAdministrator>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
- administratorName
-
string
The name of server active directory administrator.
The options parameters.
Returns
Promise<ServerAzureADAdministrator>
listByServer(string, string, ServerAzureADAdministratorsListByServerOptionalParams)
Gets a list of Azure Active Directory administrators in a server.
function listByServer(resourceGroupName: string, serverName: string, options?: ServerAzureADAdministratorsListByServerOptionalParams): PagedAsyncIterableIterator<ServerAzureADAdministrator, ServerAzureADAdministrator[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- serverName
-
string
The name of the server.
The options parameters.