RolesOperations interface

Package:

@azure/arm-databoxedge

Interface representing a Roles operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
createOrUpdate	Create or update a role.
delete	Deletes the role on the device.
get	Gets a specific role by name.
listByDataBoxEdgeDevice	Lists all the roles configured in 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, role: RoleUnion, options?: RolesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<RoleUnion>, RoleUnion>>

Property Value

(deviceName: string, name: string, resourceGroupName: string, role: RoleUnion, options?: RolesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<RoleUnion>, RoleUnion>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

createOrUpdate

Create or update a role.

createOrUpdate: (deviceName: string, name: string, resourceGroupName: string, role: RoleUnion, options?: RolesCreateOrUpdateOptionalParams) => PollerLike<OperationState<RoleUnion>, RoleUnion>

Property Value

(deviceName: string, name: string, resourceGroupName: string, role: RoleUnion, options?: RolesCreateOrUpdateOptionalParams) => PollerLike<OperationState<RoleUnion>, RoleUnion>

delete

Deletes the role on the device.

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

Property Value

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

get

Gets a specific role by name.

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

Property Value

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

listByDataBoxEdgeDevice

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

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

Property Value

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