Roles interface

Package:

@azure/arm-databoxedge

Interface representing a Roles.

Methods

beginCreateOrUpdate(string, string, string, RoleUnion, RolesCreateOrUpdateOptionalParams)	Create or update a role.
beginCreateOrUpdateAndWait(string, string, string, RoleUnion, RolesCreateOrUpdateOptionalParams)	Create or update a role.
beginDelete(string, string, string, RolesDeleteOptionalParams)	Deletes the role on the device.
beginDeleteAndWait(string, string, string, RolesDeleteOptionalParams)	Deletes the role on the device.
get(string, string, string, RolesGetOptionalParams)	Gets a specific role by name.
listByDataBoxEdgeDevice(string, string, RolesListByDataBoxEdgeDeviceOptionalParams)	Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

Method Details

beginCreateOrUpdate(string, string, string, RoleUnion, RolesCreateOrUpdateOptionalParams)

Create or update a role.

function beginCreateOrUpdate(deviceName: string, name: string, resourceGroupName: string, role: RoleUnion, options?: RolesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<RoleUnion>, RoleUnion>>

Parameters

deviceName

string

The device name.

name

string

The role name.

resourceGroupName

string

The resource group name.

role

RoleUnion

The role properties.

options

RolesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, RoleUnion, RolesCreateOrUpdateOptionalParams)

Create or update a role.

function beginCreateOrUpdateAndWait(deviceName: string, name: string, resourceGroupName: string, role: RoleUnion, options?: RolesCreateOrUpdateOptionalParams): Promise<RoleUnion>

Parameters

deviceName

string

The device name.

name

string

The role name.

resourceGroupName

string

The resource group name.

role

RoleUnion

The role properties.

options

RolesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<RoleUnion>

beginDelete(string, string, string, RolesDeleteOptionalParams)

Deletes the role on the device.

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

Parameters

deviceName

string

The device name.

name

string

The role name.

resourceGroupName

string

The resource group name.

options

RolesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, RolesDeleteOptionalParams)

Deletes the role on the device.

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

Parameters

deviceName

string

The device name.

name

string

The role name.

resourceGroupName

string

The resource group name.

options

RolesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, RolesGetOptionalParams)

Gets a specific role by name.

function get(deviceName: string, name: string, resourceGroupName: string, options?: RolesGetOptionalParams): Promise<RoleUnion>

Parameters

deviceName

string

The device name.

name

string

The role name.

resourceGroupName

string

The resource group name.

options

RolesGetOptionalParams

The options parameters.

Returns

Promise<RoleUnion>

listByDataBoxEdgeDevice(string, string, RolesListByDataBoxEdgeDeviceOptionalParams)

Lists all the roles configured in a Data Box Edge/Data Box Gateway device.

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

Parameters

deviceName

string

The device name.

resourceGroupName

string

The resource group name.

options

RolesListByDataBoxEdgeDeviceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RoleUnion, RoleUnion[], PageSettings>