Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Users

Package version

Class representing a Users.

Hierarchy

  • Users

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(deviceName: string, name: string, resourceGroupName: string, options?: Models.UsersBeginCreateOrUpdateOptionalParams): Promise<msRestAzure.LROPoller>

  • Creates a new user or updates an existing user's information on a data box edge/gateway device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The user name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: Models.UsersBeginCreateOrUpdateOptionalParams

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Deletes the user on a databox edge/gateway device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The user name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(deviceName: string, name: string, resourceGroupName: string, options?: Models.UsersCreateOrUpdateOptionalParams): Promise<Models.UsersCreateOrUpdateResponse>

  • Creates a new user or updates an existing user's information on a data box edge/gateway device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The user name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: Models.UsersCreateOrUpdateOptionalParams

    Returns Promise<Models.UsersCreateOrUpdateResponse>

    Promise<Models.UsersCreateOrUpdateResponse>

deleteMethod

  • deleteMethod(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Deletes the user on a databox edge/gateway device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The user name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(deviceName: string, name: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.UsersGetResponse>
  • get(deviceName: string, name: string, resourceGroupName: string, callback: msRest.ServiceCallback<User>): void
  • get(deviceName: string, name: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<User>): void

  • Gets the properties of the specified user.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The user name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.UsersGetResponse>

    Promise<Models.UsersGetResponse>

  • Parameters

    • deviceName: string

      The device name.

    • name: string

      The user name.

    • resourceGroupName: string

      The resource group name.

    • callback: msRest.ServiceCallback<User>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • name: string

      The user name.

    • resourceGroupName: string

      The resource group name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<User>

      The callback

    Returns void

listByDataBoxEdgeDevice

  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.UsersListByDataBoxEdgeDeviceResponse>
  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, callback: msRest.ServiceCallback<UserList>): void
  • listByDataBoxEdgeDevice(deviceName: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<UserList>): void

  • Gets all the users registered on a data box edge/gateway device.

    Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.UsersListByDataBoxEdgeDeviceResponse>

    Promise<Models.UsersListByDataBoxEdgeDeviceResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • callback: msRest.ServiceCallback<UserList>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<UserList>

      The callback

    Returns void

listByDataBoxEdgeDeviceNext

  • listByDataBoxEdgeDeviceNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.UsersListByDataBoxEdgeDeviceNextResponse>
  • listByDataBoxEdgeDeviceNext(nextPageLink: string, callback: msRest.ServiceCallback<UserList>): void
  • listByDataBoxEdgeDeviceNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<UserList>): void

  • Gets all the users registered on a data box edge/gateway device.

    Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.UsersListByDataBoxEdgeDeviceNextResponse>

    Promise<Models.UsersListByDataBoxEdgeDeviceNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<UserList>

      The callback

    Returns void

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<UserList>

      The callback

    Returns void

Generated using TypeDoc