Package version:

Interface ServerAzureADAdministrators

Interface representing a ServerAzureADAdministrators.

Hierarchy

ServerAzureADAdministrators

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get listByServer

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, administratorName: string, parameters: ServerAzureADAdministrator, options?: ServerAzureADAdministratorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServerAzureADAdministrator>, ServerAzureADAdministrator>>
Creates or updates an existing Azure Active Directory administrator.
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.
- Optional options: ServerAzureADAdministratorsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ServerAzureADAdministrator>, ServerAzureADAdministrator>>
- Defined in operationsInterfaces/serverAzureADAdministrators.ts:60

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, administratorName: string, parameters: ServerAzureADAdministrator, options?: ServerAzureADAdministratorsCreateOrUpdateOptionalParams): Promise<ServerAzureADAdministrator>
Creates or updates an existing Azure Active Directory administrator.
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.
- Optional options: ServerAzureADAdministratorsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ServerAzureADAdministrator>
- Defined in operationsInterfaces/serverAzureADAdministrators.ts:81

beginDelete

beginDelete(resourceGroupName: string, serverName: string, administratorName: string, options?: ServerAzureADAdministratorsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes the Azure Active Directory administrator with the given name.
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.
- Optional options: ServerAzureADAdministratorsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/serverAzureADAdministrators.ts:96

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, administratorName: string, options?: ServerAzureADAdministratorsDeleteOptionalParams): Promise<void>
Deletes the Azure Active Directory administrator with the given name.
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.
- Optional options: ServerAzureADAdministratorsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/serverAzureADAdministrators.ts:110

get

get(resourceGroupName: string, serverName: string, administratorName: string, options?: ServerAzureADAdministratorsGetOptionalParams): Promise<ServerAzureADAdministrator>
Gets a Azure Active Directory administrator.
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.
- Optional options: ServerAzureADAdministratorsGetOptionalParams
  
  The options parameters.
Returns Promise<ServerAzureADAdministrator>
- Defined in operationsInterfaces/serverAzureADAdministrators.ts:45

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: ServerAzureADAdministratorsListByServerOptionalParams): PagedAsyncIterableIterator<ServerAzureADAdministrator>
Gets a list of Azure Active Directory administrators in a server.
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.
- Optional options: ServerAzureADAdministratorsListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ServerAzureADAdministrator>
- Defined in operationsInterfaces/serverAzureADAdministrators.ts:32

Interface ServerAzureADAdministrators

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

administratorName: string

parameters: ServerAzureADAdministrator

Optional options: ServerAzureADAdministratorsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ServerAzureADAdministrator>, ServerAzureADAdministrator>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

administratorName: string

parameters: ServerAzureADAdministrator

Optional options: ServerAzureADAdministratorsCreateOrUpdateOptionalParams

Returns Promise<ServerAzureADAdministrator>

beginDelete

Parameters

resourceGroupName: string

serverName: string

administratorName: string

Optional options: ServerAzureADAdministratorsDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

administratorName: string

Optional options: ServerAzureADAdministratorsDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serverName: string

administratorName: string

Optional options: ServerAzureADAdministratorsGetOptionalParams

Returns Promise<ServerAzureADAdministrator>

listByServer

Parameters

resourceGroupName: string

serverName: string

Optional options: ServerAzureADAdministratorsListByServerOptionalParams

Returns PagedAsyncIterableIterator<ServerAzureADAdministrator>

Settings

Member Visibility

Theme

`Optional` options: ServerAzureADAdministratorsCreateOrUpdateOptionalParams

`Optional` options: ServerAzureADAdministratorsCreateOrUpdateOptionalParams

`Optional` options: ServerAzureADAdministratorsDeleteOptionalParams

`Optional` options: ServerAzureADAdministratorsDeleteOptionalParams

`Optional` options: ServerAzureADAdministratorsGetOptionalParams

`Optional` options: ServerAzureADAdministratorsListByServerOptionalParams