DataBoxEdgeExtensions.GetDataBoxEdgeDevice Method

Definition

Namespace:

Azure.ResourceManager.DataBoxEdge

Assembly:

Azure.ResourceManager.DataBoxEdge.dll

Package:

Azure.ResourceManager.DataBoxEdge v1.1.2

Source:

DataBoxEdgeExtensions.cs

Gets the properties of the Data Box Edge/Data Box Gateway device. <item> Mocking. To mock this method, please mock GetDataBoxEdgeDevice(String, CancellationToken) instead. </item>

public static Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeDeviceResource> GetDataBoxEdgeDevice(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string deviceName, System.Threading.CancellationToken cancellationToken = default);

static member GetDataBoxEdgeDevice : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.DataBoxEdge.DataBoxEdgeDeviceResource>

<Extension()>
Public Function GetDataBoxEdgeDevice (resourceGroupResource As ResourceGroupResource, deviceName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DataBoxEdgeDeviceResource)

Parameters

resourceGroupResource

ResourceGroupResource

The ResourceGroupResource the method will execute against.

deviceName

String

The device name.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<DataBoxEdgeDeviceResource>

Exceptions

ArgumentException

deviceName is an empty string, and was expected to be non-empty.

ArgumentNullException

resourceGroupResource is null.