共用方式為


Users interface

Interface representing a Users.

Methods

beginCreateOrUpdate(string, string, string, User, UsersCreateOrUpdateOptionalParams)

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

beginCreateOrUpdateAndWait(string, string, string, User, UsersCreateOrUpdateOptionalParams)

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

beginDelete(string, string, string, UsersDeleteOptionalParams)

Deletes the user on a databox edge/gateway device.

beginDeleteAndWait(string, string, string, UsersDeleteOptionalParams)

Deletes the user on a databox edge/gateway device.

get(string, string, string, UsersGetOptionalParams)

Gets the properties of the specified user.

listByDataBoxEdgeDevice(string, string, UsersListByDataBoxEdgeDeviceOptionalParams)

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

Method Details

beginCreateOrUpdate(string, string, string, User, UsersCreateOrUpdateOptionalParams)

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

function beginCreateOrUpdate(deviceName: string, name: string, resourceGroupName: string, user: User, options?: UsersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<User>, User>>

Parameters

deviceName

string

The device name.

name

string

The user name.

resourceGroupName

string

The resource group name.

user
User

The user details.

options
UsersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<User>, User>>

beginCreateOrUpdateAndWait(string, string, string, User, UsersCreateOrUpdateOptionalParams)

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

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

Parameters

deviceName

string

The device name.

name

string

The user name.

resourceGroupName

string

The resource group name.

user
User

The user details.

options
UsersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<User>

beginDelete(string, string, string, UsersDeleteOptionalParams)

Deletes the user on a databox edge/gateway device.

function beginDelete(deviceName: string, name: string, resourceGroupName: string, options?: UsersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

deviceName

string

The device name.

name

string

The user name.

resourceGroupName

string

The resource group name.

options
UsersDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, UsersDeleteOptionalParams)

Deletes the user on a databox edge/gateway device.

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

Parameters

deviceName

string

The device name.

name

string

The user name.

resourceGroupName

string

The resource group name.

options
UsersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, UsersGetOptionalParams)

Gets the properties of the specified user.

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

Parameters

deviceName

string

The device name.

name

string

The user name.

resourceGroupName

string

The resource group name.

options
UsersGetOptionalParams

The options parameters.

Returns

Promise<User>

listByDataBoxEdgeDevice(string, string, UsersListByDataBoxEdgeDeviceOptionalParams)

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

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

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options
UsersListByDataBoxEdgeDeviceOptionalParams

The options parameters.

Returns