MicrosoftEntraAuthenticationsOperations interface

Package:

@azure/arm-horizondb

Interface representing a MicrosoftEntraAuthentications operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginUpdate
beginUpdateAndWait
createOrReplace	Creates or replaces the service-created Microsoft Entra authentication method. State Enabled enables the feature and State Disabled disables it; no additional properties are required. Repeating the same request is idempotent. Disabling the feature does not remove or modify database roles or users previously created through the MicrosoftEntraAdministrators control-plane API or directly through pgaadauth extension functions.
get	Gets the service-created Microsoft Entra authentication method.
update	Updates the service-created Microsoft Entra authentication method. State Enabled enables the feature and State Disabled disables it; no additional properties are required. Disabling the feature does not remove or modify database roles or users previously created through the MicrosoftEntraAdministrators control-plane API or directly through pgaadauth extension functions.

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, resource: MicrosoftEntraAuthenticationCreateOrUpdate, options?: MicrosoftEntraAuthenticationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<MicrosoftEntraAuthentication>, MicrosoftEntraAuthentication>>

Property Value

(resourceGroupName: string, clusterName: string, resource: MicrosoftEntraAuthenticationCreateOrUpdate, options?: MicrosoftEntraAuthenticationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<MicrosoftEntraAuthentication>, MicrosoftEntraAuthentication>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, resource: MicrosoftEntraAuthenticationCreateOrUpdate, options?: MicrosoftEntraAuthenticationsCreateOrReplaceOptionalParams) => Promise<MicrosoftEntraAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, resource: MicrosoftEntraAuthenticationCreateOrUpdate, options?: MicrosoftEntraAuthenticationsCreateOrReplaceOptionalParams) => Promise<MicrosoftEntraAuthentication>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, properties: MicrosoftEntraAuthenticationForPatchUpdateUpdate, options?: MicrosoftEntraAuthenticationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<MicrosoftEntraAuthentication>, MicrosoftEntraAuthentication>>

Property Value

(resourceGroupName: string, clusterName: string, properties: MicrosoftEntraAuthenticationForPatchUpdateUpdate, options?: MicrosoftEntraAuthenticationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<MicrosoftEntraAuthentication>, MicrosoftEntraAuthentication>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, properties: MicrosoftEntraAuthenticationForPatchUpdateUpdate, options?: MicrosoftEntraAuthenticationsUpdateOptionalParams) => Promise<MicrosoftEntraAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, properties: MicrosoftEntraAuthenticationForPatchUpdateUpdate, options?: MicrosoftEntraAuthenticationsUpdateOptionalParams) => Promise<MicrosoftEntraAuthentication>

createOrReplace

Creates or replaces the service-created Microsoft Entra authentication method. State Enabled enables the feature and State Disabled disables it; no additional properties are required. Repeating the same request is idempotent. Disabling the feature does not remove or modify database roles or users previously created through the MicrosoftEntraAdministrators control-plane API or directly through pgaadauth extension functions.

createOrReplace: (resourceGroupName: string, clusterName: string, resource: MicrosoftEntraAuthenticationCreateOrUpdate, options?: MicrosoftEntraAuthenticationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<MicrosoftEntraAuthentication>, MicrosoftEntraAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, resource: MicrosoftEntraAuthenticationCreateOrUpdate, options?: MicrosoftEntraAuthenticationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<MicrosoftEntraAuthentication>, MicrosoftEntraAuthentication>

get

Gets the service-created Microsoft Entra authentication method.

get: (resourceGroupName: string, clusterName: string, options?: MicrosoftEntraAuthenticationsGetOptionalParams) => Promise<MicrosoftEntraAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, options?: MicrosoftEntraAuthenticationsGetOptionalParams) => Promise<MicrosoftEntraAuthentication>

update

Updates the service-created Microsoft Entra authentication method. State Enabled enables the feature and State Disabled disables it; no additional properties are required. Disabling the feature does not remove or modify database roles or users previously created through the MicrosoftEntraAdministrators control-plane API or directly through pgaadauth extension functions.

update: (resourceGroupName: string, clusterName: string, properties: MicrosoftEntraAuthenticationForPatchUpdateUpdate, options?: MicrosoftEntraAuthenticationsUpdateOptionalParams) => PollerLike<OperationState<MicrosoftEntraAuthentication>, MicrosoftEntraAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, properties: MicrosoftEntraAuthenticationForPatchUpdateUpdate, options?: MicrosoftEntraAuthenticationsUpdateOptionalParams) => PollerLike<OperationState<MicrosoftEntraAuthentication>, MicrosoftEntraAuthentication>