Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Roles

Package version

Class representing a Roles.

Hierarchy

  • Roles

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreateOrUpdate

  • beginCreateOrUpdate(deviceName: string, name: string, role: Models.RoleUnion, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Create or update a role.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The role name.

    • role: Models.RoleUnion

      The role properties.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

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

  • Deletes the role on the data box edge device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The role name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

createOrUpdate

  • createOrUpdate(deviceName: string, name: string, role: Models.RoleUnion, resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.RolesCreateOrUpdateResponse>

  • Create or update a role.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The role name.

    • role: Models.RoleUnion

      The role properties.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RolesCreateOrUpdateResponse>

    Promise<Models.RolesCreateOrUpdateResponse>

deleteMethod

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

  • Deletes the role on the data box edge device.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The role 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.RolesGetResponse>
  • get(deviceName: string, name: string, resourceGroupName: string, callback: msRest.ServiceCallback<Models.RoleUnion>): void
  • get(deviceName: string, name: string, resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.RoleUnion>): void

  • Gets a specific role by name.

    Parameters

    • deviceName: string

      The device name.

    • name: string

      The role name.

    • resourceGroupName: string

      The resource group name.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.RolesGetResponse>

    Promise<Models.RolesGetResponse>

  • Parameters

    • deviceName: string

      The device name.

    • name: string

      The role name.

    • resourceGroupName: string

      The resource group name.

    • callback: msRest.ServiceCallback<Models.RoleUnion>

      The callback

    Returns void

  • Parameters

    • deviceName: string

      The device name.

    • name: string

      The role name.

    • resourceGroupName: string

      The resource group name.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Models.RoleUnion>

      The callback

    Returns void

listByDataBoxEdgeDevice

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

  • Lists all the roles configured in 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.RolesListByDataBoxEdgeDeviceResponse>

    Promise<Models.RolesListByDataBoxEdgeDeviceResponse>

  • Parameters

    • deviceName: string

      The device name.

    • resourceGroupName: string

      The resource group name.

    • callback: msRest.ServiceCallback<RoleList>

      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<RoleList>

      The callback

    Returns void

listByDataBoxEdgeDeviceNext

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

  • Lists all the roles configured in 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.RolesListByDataBoxEdgeDeviceNextResponse>

    Promise<Models.RolesListByDataBoxEdgeDeviceNextResponse>

  • Parameters

    • nextPageLink: string

      The NextLink from the previous successful call to List operation.

    • callback: msRest.ServiceCallback<RoleList>

      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<RoleList>

      The callback

    Returns void

Generated using TypeDoc