MicrosoftEntraAdministratorsOperations interface

Package:

@azure/arm-horizondb

Interface representing a MicrosoftEntraAdministrators operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginDelete
beginDeleteAndWait
createOrReplace	Creates or replaces a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.
delete	Deletes a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.
get	Gets information about a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.
list	Lists the PostgreSQL roles in a cluster that are members of azure_pg_admin and mapped to Microsoft Entra principals.

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, objectId: string, resource: MicrosoftEntraAdministratorAdd, options?: MicrosoftEntraAdministratorsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<MicrosoftEntraAdministrator>, MicrosoftEntraAdministrator>>

Property Value

(resourceGroupName: string, clusterName: string, objectId: string, resource: MicrosoftEntraAdministratorAdd, options?: MicrosoftEntraAdministratorsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<MicrosoftEntraAdministrator>, MicrosoftEntraAdministrator>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, objectId: string, resource: MicrosoftEntraAdministratorAdd, options?: MicrosoftEntraAdministratorsCreateOrReplaceOptionalParams) => Promise<MicrosoftEntraAdministrator>

Property Value

(resourceGroupName: string, clusterName: string, objectId: string, resource: MicrosoftEntraAdministratorAdd, options?: MicrosoftEntraAdministratorsCreateOrReplaceOptionalParams) => Promise<MicrosoftEntraAdministrator>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, objectId: string, options?: MicrosoftEntraAdministratorsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, objectId: string, options?: MicrosoftEntraAdministratorsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, objectId: string, options?: MicrosoftEntraAdministratorsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, objectId: string, options?: MicrosoftEntraAdministratorsDeleteOptionalParams) => Promise<void>

createOrReplace

Creates or replaces a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.

createOrReplace: (resourceGroupName: string, clusterName: string, objectId: string, resource: MicrosoftEntraAdministratorAdd, options?: MicrosoftEntraAdministratorsCreateOrReplaceOptionalParams) => PollerLike<OperationState<MicrosoftEntraAdministrator>, MicrosoftEntraAdministrator>

Property Value

(resourceGroupName: string, clusterName: string, objectId: string, resource: MicrosoftEntraAdministratorAdd, options?: MicrosoftEntraAdministratorsCreateOrReplaceOptionalParams) => PollerLike<OperationState<MicrosoftEntraAdministrator>, MicrosoftEntraAdministrator>

delete

Deletes a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.

delete: (resourceGroupName: string, clusterName: string, objectId: string, options?: MicrosoftEntraAdministratorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, objectId: string, options?: MicrosoftEntraAdministratorsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets information about a PostgreSQL role that is a member of azure_pg_admin and mapped to a Microsoft Entra principal.

get: (resourceGroupName: string, clusterName: string, objectId: string, options?: MicrosoftEntraAdministratorsGetOptionalParams) => Promise<MicrosoftEntraAdministrator>

Property Value

(resourceGroupName: string, clusterName: string, objectId: string, options?: MicrosoftEntraAdministratorsGetOptionalParams) => Promise<MicrosoftEntraAdministrator>

list

Lists the PostgreSQL roles in a cluster that are members of azure_pg_admin and mapped to Microsoft Entra principals.

list: (resourceGroupName: string, clusterName: string, options?: MicrosoftEntraAdministratorsListOptionalParams) => PagedAsyncIterableIterator<MicrosoftEntraAdministrator, MicrosoftEntraAdministrator[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, options?: MicrosoftEntraAdministratorsListOptionalParams) => PagedAsyncIterableIterator<MicrosoftEntraAdministrator, MicrosoftEntraAdministrator[], PageSettings>