Azure Native

v1.88.1 published on Thursday, Dec 1, 2022 by Pulumi

getDevice

The Data Box Edge/Gateway device. API Version: 2020-12-01.

Using getDevice

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDevice(args: GetDeviceArgs, opts?: InvokeOptions): Promise<GetDeviceResult>
function getDeviceOutput(args: GetDeviceOutputArgs, opts?: InvokeOptions): Output<GetDeviceResult>
def get_device(device_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDeviceResult
def get_device_output(device_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDeviceResult]
func LookupDevice(ctx *Context, args *LookupDeviceArgs, opts ...InvokeOption) (*LookupDeviceResult, error)
func LookupDeviceOutput(ctx *Context, args *LookupDeviceOutputArgs, opts ...InvokeOption) LookupDeviceResultOutput

> Note: This function is named LookupDevice in the Go SDK.

public static class GetDevice 
{
    public static Task<GetDeviceResult> InvokeAsync(GetDeviceArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceResult> Invoke(GetDeviceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeviceResult> getDevice(GetDeviceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:databoxedge:getDevice
  arguments:
    # arguments dictionary

The following arguments are supported:

DeviceName string

The device name.

ResourceGroupName string

The resource group name.

DeviceName string

The device name.

ResourceGroupName string

The resource group name.

deviceName String

The device name.

resourceGroupName String

The resource group name.

deviceName string

The device name.

resourceGroupName string

The resource group name.

device_name str

The device name.

resource_group_name str

The resource group name.

deviceName String

The device name.

resourceGroupName String

The resource group name.

getDevice Result

The following output properties are available:

ConfiguredRoleTypes List<string>

Type of compute roles configured.

Culture string

The Data Box Edge/Gateway device culture.

Description string

The Description of the Data Box Edge/Gateway device.

DeviceHcsVersion string

The device software version number of the device (eg: 1.2.18105.6).

DeviceLocalCapacity double

The Data Box Edge/Gateway device local capacity in MB.

DeviceModel string

The Data Box Edge/Gateway device model.

DeviceSoftwareVersion string

The Data Box Edge/Gateway device software version.

DeviceType string

The type of the Data Box Edge/Gateway device.

EdgeProfile Pulumi.AzureNative.DataBoxEdge.Outputs.EdgeProfileResponse

The details of Edge Profile for this resource

FriendlyName string

The Data Box Edge/Gateway device name.

Id string

The path ID that uniquely identifies the object.

Kind string

The etag for the devices.

Location string

The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.

ModelDescription string

The description of the Data Box Edge/Gateway device model.

Name string

The object name.

NodeCount int

The number of nodes in the cluster.

ResourceMoveDetails Pulumi.AzureNative.DataBoxEdge.Outputs.ResourceMoveDetailsResponse

The details of the move operation on this resource.

SerialNumber string

The Serial Number of Data Box Edge/Gateway device.

SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse

DataBoxEdge Resource

TimeZone string

The Data Box Edge/Gateway device timezone.

Type string

The hierarchical type of the object.

DataBoxEdgeDeviceStatus string

The status of the Data Box Edge/Gateway device.

Etag string

The etag for the devices.

Identity Pulumi.AzureNative.DataBoxEdge.Outputs.ResourceIdentityResponse

Msi identity of the resource

Sku Pulumi.AzureNative.DataBoxEdge.Outputs.SkuResponse

The SKU type.

Tags Dictionary<string, string>

The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).

ConfiguredRoleTypes []string

Type of compute roles configured.

Culture string

The Data Box Edge/Gateway device culture.

Description string

The Description of the Data Box Edge/Gateway device.

DeviceHcsVersion string

The device software version number of the device (eg: 1.2.18105.6).

DeviceLocalCapacity float64

The Data Box Edge/Gateway device local capacity in MB.

DeviceModel string

The Data Box Edge/Gateway device model.

DeviceSoftwareVersion string

The Data Box Edge/Gateway device software version.

DeviceType string

The type of the Data Box Edge/Gateway device.

EdgeProfile EdgeProfileResponse

The details of Edge Profile for this resource

FriendlyName string

The Data Box Edge/Gateway device name.

Id string

The path ID that uniquely identifies the object.

Kind string

The etag for the devices.

Location string

The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.

ModelDescription string

The description of the Data Box Edge/Gateway device model.

Name string

The object name.

NodeCount int

The number of nodes in the cluster.

ResourceMoveDetails ResourceMoveDetailsResponse

The details of the move operation on this resource.

SerialNumber string

The Serial Number of Data Box Edge/Gateway device.

SystemData SystemDataResponse

DataBoxEdge Resource

TimeZone string

The Data Box Edge/Gateway device timezone.

Type string

The hierarchical type of the object.

DataBoxEdgeDeviceStatus string

The status of the Data Box Edge/Gateway device.

Etag string

The etag for the devices.

Identity ResourceIdentityResponse

Msi identity of the resource

Sku SkuResponse

The SKU type.

Tags map[string]string

The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).

configuredRoleTypes List<String>

Type of compute roles configured.

culture String

The Data Box Edge/Gateway device culture.

description String

The Description of the Data Box Edge/Gateway device.

deviceHcsVersion String

The device software version number of the device (eg: 1.2.18105.6).

deviceLocalCapacity Double

The Data Box Edge/Gateway device local capacity in MB.

deviceModel String

The Data Box Edge/Gateway device model.

deviceSoftwareVersion String

The Data Box Edge/Gateway device software version.

deviceType String

The type of the Data Box Edge/Gateway device.

edgeProfile EdgeProfileResponse

The details of Edge Profile for this resource

friendlyName String

The Data Box Edge/Gateway device name.

id String

The path ID that uniquely identifies the object.

kind String

The etag for the devices.

location String

The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.

modelDescription String

The description of the Data Box Edge/Gateway device model.

name String

The object name.

nodeCount Integer

The number of nodes in the cluster.

resourceMoveDetails ResourceMoveDetailsResponse

The details of the move operation on this resource.

serialNumber String

The Serial Number of Data Box Edge/Gateway device.

systemData SystemDataResponse

DataBoxEdge Resource

timeZone String

The Data Box Edge/Gateway device timezone.

type String

The hierarchical type of the object.

dataBoxEdgeDeviceStatus String

The status of the Data Box Edge/Gateway device.

etag String

The etag for the devices.

identity ResourceIdentityResponse

Msi identity of the resource

sku SkuResponse

The SKU type.

tags Map<String,String>

The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).

configuredRoleTypes string[]

Type of compute roles configured.

culture string

The Data Box Edge/Gateway device culture.

description string

The Description of the Data Box Edge/Gateway device.

deviceHcsVersion string

The device software version number of the device (eg: 1.2.18105.6).

deviceLocalCapacity number

The Data Box Edge/Gateway device local capacity in MB.

deviceModel string

The Data Box Edge/Gateway device model.

deviceSoftwareVersion string

The Data Box Edge/Gateway device software version.

deviceType string

The type of the Data Box Edge/Gateway device.

edgeProfile EdgeProfileResponse

The details of Edge Profile for this resource

friendlyName string

The Data Box Edge/Gateway device name.

id string

The path ID that uniquely identifies the object.

kind string

The etag for the devices.

location string

The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.

modelDescription string

The description of the Data Box Edge/Gateway device model.

name string

The object name.

nodeCount number

The number of nodes in the cluster.

resourceMoveDetails ResourceMoveDetailsResponse

The details of the move operation on this resource.

serialNumber string

The Serial Number of Data Box Edge/Gateway device.

systemData SystemDataResponse

DataBoxEdge Resource

timeZone string

The Data Box Edge/Gateway device timezone.

type string

The hierarchical type of the object.

dataBoxEdgeDeviceStatus string

The status of the Data Box Edge/Gateway device.

etag string

The etag for the devices.

identity ResourceIdentityResponse

Msi identity of the resource

sku SkuResponse

The SKU type.

tags {[key: string]: string}

The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).

configured_role_types Sequence[str]

Type of compute roles configured.

culture str

The Data Box Edge/Gateway device culture.

description str

The Description of the Data Box Edge/Gateway device.

device_hcs_version str

The device software version number of the device (eg: 1.2.18105.6).

device_local_capacity float

The Data Box Edge/Gateway device local capacity in MB.

device_model str

The Data Box Edge/Gateway device model.

device_software_version str

The Data Box Edge/Gateway device software version.

device_type str

The type of the Data Box Edge/Gateway device.

edge_profile EdgeProfileResponse

The details of Edge Profile for this resource

friendly_name str

The Data Box Edge/Gateway device name.

id str

The path ID that uniquely identifies the object.

kind str

The etag for the devices.

location str

The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.

model_description str

The description of the Data Box Edge/Gateway device model.

name str

The object name.

node_count int

The number of nodes in the cluster.

resource_move_details ResourceMoveDetailsResponse

The details of the move operation on this resource.

serial_number str

The Serial Number of Data Box Edge/Gateway device.

system_data SystemDataResponse

DataBoxEdge Resource

time_zone str

The Data Box Edge/Gateway device timezone.

type str

The hierarchical type of the object.

data_box_edge_device_status str

The status of the Data Box Edge/Gateway device.

etag str

The etag for the devices.

identity ResourceIdentityResponse

Msi identity of the resource

sku SkuResponse

The SKU type.

tags Mapping[str, str]

The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).

configuredRoleTypes List<String>

Type of compute roles configured.

culture String

The Data Box Edge/Gateway device culture.

description String

The Description of the Data Box Edge/Gateway device.

deviceHcsVersion String

The device software version number of the device (eg: 1.2.18105.6).

deviceLocalCapacity Number

The Data Box Edge/Gateway device local capacity in MB.

deviceModel String

The Data Box Edge/Gateway device model.

deviceSoftwareVersion String

The Data Box Edge/Gateway device software version.

deviceType String

The type of the Data Box Edge/Gateway device.

edgeProfile Property Map

The details of Edge Profile for this resource

friendlyName String

The Data Box Edge/Gateway device name.

id String

The path ID that uniquely identifies the object.

kind String

The etag for the devices.

location String

The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.

modelDescription String

The description of the Data Box Edge/Gateway device model.

name String

The object name.

nodeCount Number

The number of nodes in the cluster.

resourceMoveDetails Property Map

The details of the move operation on this resource.

serialNumber String

The Serial Number of Data Box Edge/Gateway device.

systemData Property Map

DataBoxEdge Resource

timeZone String

The Data Box Edge/Gateway device timezone.

type String

The hierarchical type of the object.

dataBoxEdgeDeviceStatus String

The status of the Data Box Edge/Gateway device.

etag String

The etag for the devices.

identity Property Map

Msi identity of the resource

sku Property Map

The SKU type.

tags Map<String>

The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).

Supporting Types

EdgeProfileResponse

subscription Property Map

Edge Profile Subscription

EdgeProfileSubscriptionResponse

Id string

ARM ID of the subscription

LocationPlacementId string
QuotaId string
RegisteredFeatures []SubscriptionRegisteredFeaturesResponse
RegistrationDate string
RegistrationId string

Edge Subscription Registration ID

SerializedDetails string
State string
SubscriptionId string
TenantId string
id String

ARM ID of the subscription

locationPlacementId String
quotaId String
registeredFeatures List<SubscriptionRegisteredFeaturesResponse>
registrationDate String
registrationId String

Edge Subscription Registration ID

serializedDetails String
state String
subscriptionId String
tenantId String
id string

ARM ID of the subscription

locationPlacementId string
quotaId string
registeredFeatures SubscriptionRegisteredFeaturesResponse[]
registrationDate string
registrationId string

Edge Subscription Registration ID

serializedDetails string
state string
subscriptionId string
tenantId string
id String

ARM ID of the subscription

locationPlacementId String
quotaId String
registeredFeatures List<Property Map>
registrationDate String
registrationId String

Edge Subscription Registration ID

serializedDetails String
state String
subscriptionId String
tenantId String

ResourceIdentityResponse

PrincipalId string

Service Principal Id backing the Msi

TenantId string

Home Tenant Id

Type string

Identity type

PrincipalId string

Service Principal Id backing the Msi

TenantId string

Home Tenant Id

Type string

Identity type

principalId String

Service Principal Id backing the Msi

tenantId String

Home Tenant Id

type String

Identity type

principalId string

Service Principal Id backing the Msi

tenantId string

Home Tenant Id

type string

Identity type

principal_id str

Service Principal Id backing the Msi

tenant_id str

Home Tenant Id

type str

Identity type

principalId String

Service Principal Id backing the Msi

tenantId String

Home Tenant Id

type String

Identity type

ResourceMoveDetailsResponse

OperationInProgress string

Denotes whether move operation is in progress

OperationInProgressLockTimeoutInUTC string

Denotes the timeout of the operation to finish

OperationInProgress string

Denotes whether move operation is in progress

OperationInProgressLockTimeoutInUTC string

Denotes the timeout of the operation to finish

operationInProgress String

Denotes whether move operation is in progress

operationInProgressLockTimeoutInUTC String

Denotes the timeout of the operation to finish

operationInProgress string

Denotes whether move operation is in progress

operationInProgressLockTimeoutInUTC string

Denotes the timeout of the operation to finish

operation_in_progress str

Denotes whether move operation is in progress

operation_in_progress_lock_timeout_in_utc str

Denotes the timeout of the operation to finish

operationInProgress String

Denotes whether move operation is in progress

operationInProgressLockTimeoutInUTC String

Denotes the timeout of the operation to finish

SkuResponse

Name string

SKU name.

Tier string

The SKU tier. This is based on the SKU name.

Name string

SKU name.

Tier string

The SKU tier. This is based on the SKU name.

name String

SKU name.

tier String

The SKU tier. This is based on the SKU name.

name string

SKU name.

tier string

The SKU tier. This is based on the SKU name.

name str

SKU name.

tier str

The SKU tier. This is based on the SKU name.

name String

SKU name.

tier String

The SKU tier. This is based on the SKU name.

SubscriptionRegisteredFeaturesResponse

Name string
State string
Name string
State string
name String
state String
name string
state string
name str
state str
name String
state String

SystemDataResponse

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The type of identity that last modified the resource.

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

CreatedAt string

The timestamp of resource creation (UTC).

CreatedBy string

The identity that created the resource.

CreatedByType string

The type of identity that created the resource.

LastModifiedAt string

The type of identity that last modified the resource.

LastModifiedBy string

The identity that last modified the resource.

LastModifiedByType string

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The type of identity that last modified the resource.

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

createdAt string

The timestamp of resource creation (UTC).

createdBy string

The identity that created the resource.

createdByType string

The type of identity that created the resource.

lastModifiedAt string

The type of identity that last modified the resource.

lastModifiedBy string

The identity that last modified the resource.

lastModifiedByType string

The type of identity that last modified the resource.

created_at str

The timestamp of resource creation (UTC).

created_by str

The identity that created the resource.

created_by_type str

The type of identity that created the resource.

last_modified_at str

The type of identity that last modified the resource.

last_modified_by str

The identity that last modified the resource.

last_modified_by_type str

The type of identity that last modified the resource.

createdAt String

The timestamp of resource creation (UTC).

createdBy String

The identity that created the resource.

createdByType String

The type of identity that created the resource.

lastModifiedAt String

The type of identity that last modified the resource.

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0