UsersOperations interface

Package:

@azure/arm-databoxedge

Interface representing a Users operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
createOrUpdate	Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.
delete	Deletes the user on a databox edge/gateway device.
get	Gets the properties of the specified user.
listByDataBoxEdgeDevice	Gets all the users registered on a Data Box Edge/Data Box Gateway device.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (deviceName: string, name: string, resourceGroupName: string, user: User, options?: UsersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<User>, User>>

Property Value

(deviceName: string, name: string, resourceGroupName: string, user: User, options?: UsersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<User>, User>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (deviceName: string, name: string, resourceGroupName: string, user: User, options?: UsersCreateOrUpdateOptionalParams) => Promise<User>

Property Value

(deviceName: string, name: string, resourceGroupName: string, user: User, options?: UsersCreateOrUpdateOptionalParams) => Promise<User>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (deviceName: string, name: string, resourceGroupName: string, options?: UsersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(deviceName: string, name: string, resourceGroupName: string, options?: UsersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (deviceName: string, name: string, resourceGroupName: string, options?: UsersDeleteOptionalParams) => Promise<void>

Property Value

(deviceName: string, name: string, resourceGroupName: string, options?: UsersDeleteOptionalParams) => Promise<void>

createOrUpdate

Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.

createOrUpdate: (deviceName: string, name: string, resourceGroupName: string, user: User, options?: UsersCreateOrUpdateOptionalParams) => PollerLike<OperationState<User>, User>

Property Value

(deviceName: string, name: string, resourceGroupName: string, user: User, options?: UsersCreateOrUpdateOptionalParams) => PollerLike<OperationState<User>, User>

delete

Deletes the user on a databox edge/gateway device.

delete: (deviceName: string, name: string, resourceGroupName: string, options?: UsersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(deviceName: string, name: string, resourceGroupName: string, options?: UsersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets the properties of the specified user.

get: (deviceName: string, name: string, resourceGroupName: string, options?: UsersGetOptionalParams) => Promise<User>

Property Value

(deviceName: string, name: string, resourceGroupName: string, options?: UsersGetOptionalParams) => Promise<User>

listByDataBoxEdgeDevice

Gets all the users registered on a Data Box Edge/Data Box Gateway device.

listByDataBoxEdgeDevice: (deviceName: string, resourceGroupName: string, options?: UsersListByDataBoxEdgeDeviceOptionalParams) => PagedAsyncIterableIterator<User, User[], PageSettings>

Property Value

(deviceName: string, resourceGroupName: string, options?: UsersListByDataBoxEdgeDeviceOptionalParams) => PagedAsyncIterableIterator<User, User[], PageSettings>