AzureADAdministrators interface

Package:

@azure/arm-mysql-flexible

Interface representing a AzureADAdministrators.

Methods

beginCreateOrUpdate(string, string, string, AzureADAdministrator, AzureADAdministratorsCreateOrUpdateOptionalParams)	Creates or updates an existing Azure Active Directory administrator.
beginCreateOrUpdateAndWait(string, string, string, AzureADAdministrator, AzureADAdministratorsCreateOrUpdateOptionalParams)	Creates or updates an existing Azure Active Directory administrator.
beginDelete(string, string, string, AzureADAdministratorsDeleteOptionalParams)	Deletes an Azure AD Administrator.
beginDeleteAndWait(string, string, string, AzureADAdministratorsDeleteOptionalParams)	Deletes an Azure AD Administrator.
get(string, string, string, AzureADAdministratorsGetOptionalParams)	Gets information about an azure ad administrator.
listByServer(string, string, AzureADAdministratorsListByServerOptionalParams)	List all the AAD administrators in a given server.

Method Details

beginCreateOrUpdate(string, string, string, AzureADAdministrator, AzureADAdministratorsCreateOrUpdateOptionalParams)

Creates or updates an existing Azure Active Directory administrator.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, administratorName: string, parameters: AzureADAdministrator, options?: AzureADAdministratorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AzureADAdministrator>, AzureADAdministrator>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

administratorName

string

The name of the Azure AD Administrator.

parameters

AzureADAdministrator

The required parameters for creating or updating an aad administrator.

options

AzureADAdministratorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<AzureADAdministrator>, AzureADAdministrator>>

beginCreateOrUpdateAndWait(string, string, string, AzureADAdministrator, AzureADAdministratorsCreateOrUpdateOptionalParams)

Creates or updates an existing Azure Active Directory administrator.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, administratorName: string, parameters: AzureADAdministrator, options?: AzureADAdministratorsCreateOrUpdateOptionalParams): Promise<AzureADAdministrator>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

administratorName

string

The name of the Azure AD Administrator.

parameters

AzureADAdministrator

The required parameters for creating or updating an aad administrator.

options

AzureADAdministratorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AzureADAdministrator>

beginDelete(string, string, string, AzureADAdministratorsDeleteOptionalParams)

Deletes an Azure AD Administrator.

function beginDelete(resourceGroupName: string, serverName: string, administratorName: string, options?: AzureADAdministratorsDeleteOptionalParams): 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.

administratorName

string

The name of the Azure AD Administrator.

options

AzureADAdministratorsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, AzureADAdministratorsDeleteOptionalParams)

Deletes an Azure AD Administrator.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, administratorName: string, options?: AzureADAdministratorsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

administratorName

string

The name of the Azure AD Administrator.

options

AzureADAdministratorsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, AzureADAdministratorsGetOptionalParams)

Gets information about an azure ad administrator.

function get(resourceGroupName: string, serverName: string, administratorName: string, options?: AzureADAdministratorsGetOptionalParams): Promise<AzureADAdministrator>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

administratorName

string

The name of the Azure AD Administrator.

options

AzureADAdministratorsGetOptionalParams

The options parameters.

Returns

Promise<AzureADAdministrator>

listByServer(string, string, AzureADAdministratorsListByServerOptionalParams)

List all the AAD administrators in a given server.

function listByServer(resourceGroupName: string, serverName: string, options?: AzureADAdministratorsListByServerOptionalParams): PagedAsyncIterableIterator<AzureADAdministrator, AzureADAdministrator[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

options

AzureADAdministratorsListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AzureADAdministrator, AzureADAdministrator[], PageSettings>