PasswordAuthenticationsOperations interface

Package:

@azure/arm-horizondb

Interface representing a PasswordAuthentications operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginUpdate
beginUpdateAndWait
createOrReplace	Creates or replaces the service-created PostgreSQL username-and-password authentication method.
get	Gets the service-created PostgreSQL username-and-password authentication method.
update	Updates the service-created PostgreSQL username-and-password authentication method. The request is sparse and omitted properties preserve their current values. This API version supports enabling the method, disabling the method, and resetting its password. For a cluster that already has an administrator but currently has password authentication disabled, state Enabled and administratorLoginPassword can be supplied together to re-enable password authentication and reset the password. Disabling cannot include credentials and does not remove or modify existing database users or roles. Administrator rename is not supported in this API version.

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, resource: PasswordAuthenticationCreateOrUpdate, options?: PasswordAuthenticationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<PasswordAuthentication>, PasswordAuthentication>>

Property Value

(resourceGroupName: string, clusterName: string, resource: PasswordAuthenticationCreateOrUpdate, options?: PasswordAuthenticationsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<PasswordAuthentication>, PasswordAuthentication>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, resource: PasswordAuthenticationCreateOrUpdate, options?: PasswordAuthenticationsCreateOrReplaceOptionalParams) => Promise<PasswordAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, resource: PasswordAuthenticationCreateOrUpdate, options?: PasswordAuthenticationsCreateOrReplaceOptionalParams) => Promise<PasswordAuthentication>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, properties: PasswordAuthenticationForPatchUpdateUpdate, options?: PasswordAuthenticationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<PasswordAuthentication>, PasswordAuthentication>>

Property Value

(resourceGroupName: string, clusterName: string, properties: PasswordAuthenticationForPatchUpdateUpdate, options?: PasswordAuthenticationsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<PasswordAuthentication>, PasswordAuthentication>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, properties: PasswordAuthenticationForPatchUpdateUpdate, options?: PasswordAuthenticationsUpdateOptionalParams) => Promise<PasswordAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, properties: PasswordAuthenticationForPatchUpdateUpdate, options?: PasswordAuthenticationsUpdateOptionalParams) => Promise<PasswordAuthentication>

createOrReplace

Creates or replaces the service-created PostgreSQL username-and-password authentication method.

createOrReplace: (resourceGroupName: string, clusterName: string, resource: PasswordAuthenticationCreateOrUpdate, options?: PasswordAuthenticationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<PasswordAuthentication>, PasswordAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, resource: PasswordAuthenticationCreateOrUpdate, options?: PasswordAuthenticationsCreateOrReplaceOptionalParams) => PollerLike<OperationState<PasswordAuthentication>, PasswordAuthentication>

get

Gets the service-created PostgreSQL username-and-password authentication method.

get: (resourceGroupName: string, clusterName: string, options?: PasswordAuthenticationsGetOptionalParams) => Promise<PasswordAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, options?: PasswordAuthenticationsGetOptionalParams) => Promise<PasswordAuthentication>

update

Updates the service-created PostgreSQL username-and-password authentication method. The request is sparse and omitted properties preserve their current values. This API version supports enabling the method, disabling the method, and resetting its password. For a cluster that already has an administrator but currently has password authentication disabled, state Enabled and administratorLoginPassword can be supplied together to re-enable password authentication and reset the password. Disabling cannot include credentials and does not remove or modify existing database users or roles. Administrator rename is not supported in this API version.

update: (resourceGroupName: string, clusterName: string, properties: PasswordAuthenticationForPatchUpdateUpdate, options?: PasswordAuthenticationsUpdateOptionalParams) => PollerLike<OperationState<PasswordAuthentication>, PasswordAuthentication>

Property Value

(resourceGroupName: string, clusterName: string, properties: PasswordAuthenticationForPatchUpdateUpdate, options?: PasswordAuthenticationsUpdateOptionalParams) => PollerLike<OperationState<PasswordAuthentication>, PasswordAuthentication>