AdministratorsMicrosoftEntra interface
Interface representing a AdministratorsMicrosoftEntra.
Methods
Method Details
beginCreateOrUpdate(string, string, string, AdministratorMicrosoftEntraAdd, AdministratorsMicrosoftEntraCreateOrUpdateOptionalParams)
Creates a new server administrator associated to a Microsoft Entra principal.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, objectId: string, parameters: AdministratorMicrosoftEntraAdd, options?: AdministratorsMicrosoftEntraCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AdministratorMicrosoftEntra>, AdministratorMicrosoftEntra>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Object identifier of the Microsoft Entra principal.
- parameters
- AdministratorMicrosoftEntraAdd
Required parameters for adding a server administrator associated to a Microsoft Entra principal.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AdministratorMicrosoftEntra>, AdministratorMicrosoftEntra>>
beginCreateOrUpdateAndWait(string, string, string, AdministratorMicrosoftEntraAdd, AdministratorsMicrosoftEntraCreateOrUpdateOptionalParams)
Creates a new server administrator associated to a Microsoft Entra principal.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, objectId: string, parameters: AdministratorMicrosoftEntraAdd, options?: AdministratorsMicrosoftEntraCreateOrUpdateOptionalParams): Promise<AdministratorMicrosoftEntra>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Object identifier of the Microsoft Entra principal.
- parameters
- AdministratorMicrosoftEntraAdd
Required parameters for adding a server administrator associated to a Microsoft Entra principal.
The options parameters.
Returns
Promise<AdministratorMicrosoftEntra>
beginDelete(string, string, string, AdministratorsMicrosoftEntraDeleteOptionalParams)
Deletes an existing server administrator associated to a Microsoft Entra principal.
function beginDelete(resourceGroupName: string, serverName: string, objectId: string, options?: AdministratorsMicrosoftEntraDeleteOptionalParams): Promise<SimplePollerLike<OperationState<AdministratorsMicrosoftEntraDeleteHeaders>, AdministratorsMicrosoftEntraDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Object identifier of the Microsoft Entra principal.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AdministratorsMicrosoftEntraDeleteHeaders>, AdministratorsMicrosoftEntraDeleteHeaders>>
beginDeleteAndWait(string, string, string, AdministratorsMicrosoftEntraDeleteOptionalParams)
Deletes an existing server administrator associated to a Microsoft Entra principal.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, objectId: string, options?: AdministratorsMicrosoftEntraDeleteOptionalParams): Promise<AdministratorsMicrosoftEntraDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Object identifier of the Microsoft Entra principal.
The options parameters.
Returns
get(string, string, string, AdministratorsMicrosoftEntraGetOptionalParams)
Gets information about a server administrator associated to a Microsoft Entra principal.
function get(resourceGroupName: string, serverName: string, objectId: string, options?: AdministratorsMicrosoftEntraGetOptionalParams): Promise<AdministratorMicrosoftEntra>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- objectId
-
string
Object identifier of the Microsoft Entra principal.
The options parameters.
Returns
Promise<AdministratorMicrosoftEntra>
listByServer(string, string, AdministratorsMicrosoftEntraListByServerOptionalParams)
List all server administrators associated to a Microsoft Entra principal.
function listByServer(resourceGroupName: string, serverName: string, options?: AdministratorsMicrosoftEntraListByServerOptionalParams): PagedAsyncIterableIterator<AdministratorMicrosoftEntra, AdministratorMicrosoftEntra[], 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.