DataBoxEdgeDeviceResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Class representing a DataBoxEdgeDevice along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a DataBoxEdgeDeviceResource from an instance of ArmClient using the GetDataBoxEdgeDeviceResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetDataBoxEdgeDevice method.
public class DataBoxEdgeDeviceResource : Azure.ResourceManager.ArmResource
type DataBoxEdgeDeviceResource = class
inherit ArmResource
Public Class DataBoxEdgeDeviceResource
Inherits ArmResource
- Inheritance
Constructors
DataBoxEdgeDeviceResource() |
Initializes a new instance of the DataBoxEdgeDeviceResource class for mocking. |
Fields
ResourceType |
Gets the resource type for the operations. |
Properties
Client |
Gets the ArmClient this resource client was created from. (Inherited from ArmResource) |
Data |
Gets the data representing this Feature. |
Diagnostics |
Gets the diagnostic options for this resource client. (Inherited from ArmResource) |
Endpoint |
Gets the base uri for this resource client. (Inherited from ArmResource) |
HasData |
Gets whether or not the current instance has data. |
Id |
Gets the resource identifier. (Inherited from ArmResource) |
Pipeline |
Gets the pipeline for this resource client. (Inherited from ArmResource) |
Methods
AddTag(String, String, CancellationToken) |
Add a tag to the current resource.
|
AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
CanUseTagResource(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
CanUseTagResourceAsync(CancellationToken) |
Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource) |
CheckResourceCreationFeasibility(WaitUntil, DeviceCapacityRequestContent, String, CancellationToken) |
Posts the device capacity request info to check feasibility.
|
CheckResourceCreationFeasibilityAsync(WaitUntil, DeviceCapacityRequestContent, String, CancellationToken) |
Posts the device capacity request info to check feasibility.
|
CreateOrUpdateSecuritySettings(WaitUntil, DataBoxEdgeSecuritySettings, CancellationToken) |
Updates the security settings on a Data Box Edge/Data Box Gateway device.
|
CreateOrUpdateSecuritySettingsAsync(WaitUntil, DataBoxEdgeSecuritySettings, CancellationToken) |
Updates the security settings on a Data Box Edge/Data Box Gateway device.
|
CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a DataBoxEdgeDeviceResource instance. |
Delete(WaitUntil, CancellationToken) |
Deletes the Data Box Edge/Data Box Gateway device.
|
DeleteAsync(WaitUntil, CancellationToken) |
Deletes the Data Box Edge/Data Box Gateway device.
|
DownloadUpdates(WaitUntil, CancellationToken) |
Downloads the updates on a Data Box Edge/Data Box Gateway device.
|
DownloadUpdatesAsync(WaitUntil, CancellationToken) |
Downloads the updates on a Data Box Edge/Data Box Gateway device.
|
GenerateCertificate(CancellationToken) |
Generates certificate for activation key.
|
GenerateCertificateAsync(CancellationToken) |
Generates certificate for activation key.
|
Get(CancellationToken) |
Gets the properties of the Data Box Edge/Data Box Gateway device.
|
GetAsync(CancellationToken) |
Gets the properties of the Data Box Edge/Data Box Gateway device.
|
GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetBandwidthSchedule(String, CancellationToken) |
Gets the properties of the specified bandwidth schedule.
|
GetBandwidthScheduleAsync(String, CancellationToken) |
Gets the properties of the specified bandwidth schedule.
|
GetBandwidthSchedules() |
Gets a collection of BandwidthScheduleResources in the DataBoxEdgeDevice. |
GetDataBoxEdgeAlert(String, CancellationToken) |
Gets an alert by name.
|
GetDataBoxEdgeAlertAsync(String, CancellationToken) |
Gets an alert by name.
|
GetDataBoxEdgeAlerts() |
Gets a collection of DataBoxEdgeAlertResources in the DataBoxEdgeDevice. |
GetDataBoxEdgeJob(String, CancellationToken) |
Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
|
GetDataBoxEdgeJobAsync(String, CancellationToken) |
Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.
|
GetDataBoxEdgeJobs() |
Gets a collection of DataBoxEdgeJobResources in the DataBoxEdgeDevice. |
GetDataBoxEdgeOrder() |
Gets an object representing a DataBoxEdgeOrderResource along with the instance operations that can be performed on it in the DataBoxEdgeDevice. |
GetDataBoxEdgeRole(String, CancellationToken) |
Gets a specific role by name.
|
GetDataBoxEdgeRoleAsync(String, CancellationToken) |
Gets a specific role by name.
|
GetDataBoxEdgeRoles() |
Gets a collection of DataBoxEdgeRoleResources in the DataBoxEdgeDevice. |
GetDataBoxEdgeShare(String, CancellationToken) |
Gets a share by name.
|
GetDataBoxEdgeShareAsync(String, CancellationToken) |
Gets a share by name.
|
GetDataBoxEdgeShares() |
Gets a collection of DataBoxEdgeShareResources in the DataBoxEdgeDevice. |
GetDataBoxEdgeStorageAccount(String, CancellationToken) |
Gets a StorageAccount by name.
|
GetDataBoxEdgeStorageAccountAsync(String, CancellationToken) |
Gets a StorageAccount by name.
|
GetDataBoxEdgeStorageAccountCredential(String, CancellationToken) |
Gets the properties of the specified storage account credential.
|
GetDataBoxEdgeStorageAccountCredentialAsync(String, CancellationToken) |
Gets the properties of the specified storage account credential.
|
GetDataBoxEdgeStorageAccountCredentials() |
Gets a collection of DataBoxEdgeStorageAccountCredentialResources in the DataBoxEdgeDevice. |
GetDataBoxEdgeStorageAccounts() |
Gets a collection of DataBoxEdgeStorageAccountResources in the DataBoxEdgeDevice. |
GetDataBoxEdgeTrigger(String, CancellationToken) |
Get a specific trigger by name.
|
GetDataBoxEdgeTriggerAsync(String, CancellationToken) |
Get a specific trigger by name.
|
GetDataBoxEdgeTriggers() |
Gets a collection of DataBoxEdgeTriggerResources in the DataBoxEdgeDevice. |
GetDataBoxEdgeUser(String, CancellationToken) |
Gets the properties of the specified user.
|
GetDataBoxEdgeUserAsync(String, CancellationToken) |
Gets the properties of the specified user.
|
GetDataBoxEdgeUsers() |
Gets a collection of DataBoxEdgeUserResources in the DataBoxEdgeDevice. |
GetDeviceCapacityInfo(CancellationToken) |
Gets the properties of the specified device capacity info.
|
GetDeviceCapacityInfoAsync(CancellationToken) |
Gets the properties of the specified device capacity info.
|
GetDiagnosticProactiveLogCollectionSetting() |
Gets an object representing a DiagnosticProactiveLogCollectionSettingResource along with the instance operations that can be performed on it in the DataBoxEdgeDevice. |
GetDiagnosticRemoteSupportSetting() |
Gets an object representing a DiagnosticRemoteSupportSettingResource along with the instance operations that can be performed on it in the DataBoxEdgeDevice. |
GetEdgeNodes(CancellationToken) |
Gets all the nodes currently configured under this Data Box Edge device
|
GetEdgeNodesAsync(CancellationToken) |
Gets all the nodes currently configured under this Data Box Edge device
|
GetExtendedInformation(CancellationToken) |
Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
|
GetExtendedInformationAsync(CancellationToken) |
Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.
|
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
GetNetworkSettings(CancellationToken) |
Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
|
GetNetworkSettingsAsync(CancellationToken) |
Gets the network settings of the specified Data Box Edge/Data Box Gateway device.
|
GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
GetUpdateSummary(CancellationToken) |
Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.
|
GetUpdateSummaryAsync(CancellationToken) |
Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.
|
InstallUpdates(WaitUntil, CancellationToken) |
Installs the updates on the Data Box Edge/Data Box Gateway device.
|
InstallUpdatesAsync(WaitUntil, CancellationToken) |
Installs the updates on the Data Box Edge/Data Box Gateway device.
|
RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
ScanForUpdates(WaitUntil, CancellationToken) |
Scans for updates on a Data Box Edge/Data Box Gateway device.
|
ScanForUpdatesAsync(WaitUntil, CancellationToken) |
Scans for updates on a Data Box Edge/Data Box Gateway device.
|
SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
TriggerSupportPackage(WaitUntil, TriggerSupportPackageContent, CancellationToken) |
Triggers support package on the device
|
TriggerSupportPackageAsync(WaitUntil, TriggerSupportPackageContent, CancellationToken) |
Triggers support package on the device
|
TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
Update(DataBoxEdgeDevicePatch, CancellationToken) |
Modifies a Data Box Edge/Data Box Gateway resource.
|
UpdateAsync(DataBoxEdgeDevicePatch, CancellationToken) |
Modifies a Data Box Edge/Data Box Gateway resource.
|
UpdateExtendedInformation(DataBoxEdgeDeviceExtendedInfoPatch, CancellationToken) |
Gets additional information for the specified Data Box Edge/Data Box Gateway device.
|
UpdateExtendedInformationAsync(DataBoxEdgeDeviceExtendedInfoPatch, CancellationToken) |
Gets additional information for the specified Data Box Edge/Data Box Gateway device.
|
UploadCertificate(UploadCertificateContent, CancellationToken) |
Uploads registration certificate for the device.
|
UploadCertificateAsync(UploadCertificateContent, CancellationToken) |
Uploads registration certificate for the device.
|
Extension Methods
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
GetRoleAssignment(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
GetRoleAssignments(ArmResource) |
Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstances(ArmResource) |
Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
GetRoleAssignmentScheduleRequests(ArmResource) |
Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstances(ArmResource) |
Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
GetRoleEligibilityScheduleRequests(ArmResource) |
Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
GetRoleManagementPolicy(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignments(ArmResource) |
Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy for a resource scope
|
GetSystemAssignedIdentity(ArmResource) |
Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |