@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets the properties of the Data Box Edge/Data Box Gateway device.
*
* Uses Azure REST API version 2023-07-01.
*
* Other available API versions: 2022-03-01, 2022-04-01-preview, 2022-12-01-preview, 2023-01-01-preview, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native databoxedge [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getDevice(args: GetDeviceArgs, opts?: pulumi.InvokeOptions): Promise<GetDeviceResult>;
export interface GetDeviceArgs {
/**
* The device name.
*/
deviceName: string;
/**
* The resource group name.
*/
resourceGroupName: string;
}
/**
* The Data Box Edge/Gateway device.
*/
export interface GetDeviceResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Type of compute roles configured.
*/
readonly configuredRoleTypes: string[];
/**
* The Data Box Edge/Gateway device culture.
*/
readonly culture: string;
/**
* The status of the Data Box Edge/Gateway device.
*/
readonly dataBoxEdgeDeviceStatus: string;
/**
* The details of data-residency related properties for this resource
*/
readonly dataResidency?: outputs.databoxedge.DataResidencyResponse;
/**
* The Description of the Data Box Edge/Gateway device.
*/
readonly description: string;
/**
* The device software version number of the device (eg: 1.2.18105.6).
*/
readonly deviceHcsVersion: string;
/**
* The Data Box Edge/Gateway device local capacity in MB.
*/
readonly deviceLocalCapacity: number;
/**
* The Data Box Edge/Gateway device model.
*/
readonly deviceModel: string;
/**
* The Data Box Edge/Gateway device software version.
*/
readonly deviceSoftwareVersion: string;
/**
* The type of the Data Box Edge/Gateway device.
*/
readonly deviceType: string;
/**
* The details of Edge Profile for this resource
*/
readonly edgeProfile: outputs.databoxedge.EdgeProfileResponse;
/**
* The etag for the devices.
*/
readonly etag?: string;
/**
* The Data Box Edge/Gateway device name.
*/
readonly friendlyName: string;
/**
* The path ID that uniquely identifies the object.
*/
readonly id: string;
/**
* Msi identity of the resource
*/
readonly identity?: outputs.databoxedge.ResourceIdentityResponse;
/**
* The kind of the device.
*/
readonly kind: string;
/**
* Kubernetes Workload Profile
*/
readonly kubernetesWorkloadProfile: 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.
*/
readonly location: string;
/**
* The description of the Data Box Edge/Gateway device model.
*/
readonly modelDescription: string;
/**
* The object name.
*/
readonly name: string;
/**
* The number of nodes in the cluster.
*/
readonly nodeCount: number;
/**
* The details of the move operation on this resource.
*/
readonly resourceMoveDetails: outputs.databoxedge.ResourceMoveDetailsResponse;
/**
* The Serial Number of Data Box Edge/Gateway device.
*/
readonly serialNumber: string;
/**
* The SKU type.
*/
readonly sku?: outputs.databoxedge.SkuResponse;
/**
* DataBoxEdge Resource
*/
readonly systemData: outputs.databoxedge.SystemDataResponse;
/**
* The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).
*/
readonly tags?: {
[key: string]: string;
};
/**
* The Data Box Edge/Gateway device timezone.
*/
readonly timeZone: string;
/**
* The hierarchical type of the object.
*/
readonly type: string;
}
/**
* Gets the properties of the Data Box Edge/Data Box Gateway device.
*
* Uses Azure REST API version 2023-07-01.
*
* Other available API versions: 2022-03-01, 2022-04-01-preview, 2022-12-01-preview, 2023-01-01-preview, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native databoxedge [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getDeviceOutput(args: GetDeviceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDeviceResult>;
export interface GetDeviceOutputArgs {
/**
* The device name.
*/
deviceName: pulumi.Input<string>;
/**
* The resource group name.
*/
resourceGroupName: pulumi.Input<string>;
}