1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. getDeviceExtendedInformation
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.databoxedge.getDeviceExtendedInformation

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets additional information for the specified Azure Stack 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 for details.

Using getDeviceExtendedInformation

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 getDeviceExtendedInformation(args: GetDeviceExtendedInformationArgs, opts?: InvokeOptions): Promise<GetDeviceExtendedInformationResult>
function getDeviceExtendedInformationOutput(args: GetDeviceExtendedInformationOutputArgs, opts?: InvokeOptions): Output<GetDeviceExtendedInformationResult>
Copy
def get_device_extended_information(device_name: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetDeviceExtendedInformationResult
def get_device_extended_information_output(device_name: Optional[pulumi.Input[str]] = None,
                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetDeviceExtendedInformationResult]
Copy
func GetDeviceExtendedInformation(ctx *Context, args *GetDeviceExtendedInformationArgs, opts ...InvokeOption) (*GetDeviceExtendedInformationResult, error)
func GetDeviceExtendedInformationOutput(ctx *Context, args *GetDeviceExtendedInformationOutputArgs, opts ...InvokeOption) GetDeviceExtendedInformationResultOutput
Copy

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

public static class GetDeviceExtendedInformation 
{
    public static Task<GetDeviceExtendedInformationResult> InvokeAsync(GetDeviceExtendedInformationArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceExtendedInformationResult> Invoke(GetDeviceExtendedInformationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeviceExtendedInformationResult> getDeviceExtendedInformation(GetDeviceExtendedInformationArgs args, InvokeOptions options)
public static Output<GetDeviceExtendedInformationResult> getDeviceExtendedInformation(GetDeviceExtendedInformationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:databoxedge:getDeviceExtendedInformation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.

getDeviceExtendedInformation Result

The following output properties are available:

CloudWitnessContainerName string
The Container for cloud witness in the storage account.
CloudWitnessStorageAccountName string
The Cloud Witness Storage account name.
CloudWitnessStorageEndpoint string
The Azure service endpoint of the cloud witness storage account.
ClusterWitnessType string
Cluster Witness Type
DeviceSecrets Dictionary<string, Pulumi.AzureNative.DataBoxEdge.Outputs.SecretResponse>
Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
FileShareWitnessLocation string
The witness location of file share.
FileShareWitnessUsername string
The username of file share.
Id string
The path ID that uniquely identifies the object.
Name string
The object name.
ResourceKey string
The Resource ID of the Resource.
SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of DataBoxEdgeDevice
Type string
The hierarchical type of the object.
ChannelIntegrityKeyName string
The name of Channel Integrity Key stored in the Client Key Vault
ChannelIntegrityKeyVersion string
The version of Channel Integrity Key stored in the Client Key Vault
ClientSecretStoreId string
The Key Vault ARM Id for client secrets
ClientSecretStoreUrl string
The url to access the Client Key Vault
EncryptionKey string
The public part of the encryption certificate. Client uses this to encrypt any secret.
EncryptionKeyThumbprint string
The digital signature of encrypted certificate.
KeyVaultSyncStatus string
Key vault sync status
CloudWitnessContainerName string
The Container for cloud witness in the storage account.
CloudWitnessStorageAccountName string
The Cloud Witness Storage account name.
CloudWitnessStorageEndpoint string
The Azure service endpoint of the cloud witness storage account.
ClusterWitnessType string
Cluster Witness Type
DeviceSecrets map[string]SecretResponse
Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
FileShareWitnessLocation string
The witness location of file share.
FileShareWitnessUsername string
The username of file share.
Id string
The path ID that uniquely identifies the object.
Name string
The object name.
ResourceKey string
The Resource ID of the Resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of DataBoxEdgeDevice
Type string
The hierarchical type of the object.
ChannelIntegrityKeyName string
The name of Channel Integrity Key stored in the Client Key Vault
ChannelIntegrityKeyVersion string
The version of Channel Integrity Key stored in the Client Key Vault
ClientSecretStoreId string
The Key Vault ARM Id for client secrets
ClientSecretStoreUrl string
The url to access the Client Key Vault
EncryptionKey string
The public part of the encryption certificate. Client uses this to encrypt any secret.
EncryptionKeyThumbprint string
The digital signature of encrypted certificate.
KeyVaultSyncStatus string
Key vault sync status
cloudWitnessContainerName String
The Container for cloud witness in the storage account.
cloudWitnessStorageAccountName String
The Cloud Witness Storage account name.
cloudWitnessStorageEndpoint String
The Azure service endpoint of the cloud witness storage account.
clusterWitnessType String
Cluster Witness Type
deviceSecrets Map<String,SecretResponse>
Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
fileShareWitnessLocation String
The witness location of file share.
fileShareWitnessUsername String
The username of file share.
id String
The path ID that uniquely identifies the object.
name String
The object name.
resourceKey String
The Resource ID of the Resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of DataBoxEdgeDevice
type String
The hierarchical type of the object.
channelIntegrityKeyName String
The name of Channel Integrity Key stored in the Client Key Vault
channelIntegrityKeyVersion String
The version of Channel Integrity Key stored in the Client Key Vault
clientSecretStoreId String
The Key Vault ARM Id for client secrets
clientSecretStoreUrl String
The url to access the Client Key Vault
encryptionKey String
The public part of the encryption certificate. Client uses this to encrypt any secret.
encryptionKeyThumbprint String
The digital signature of encrypted certificate.
keyVaultSyncStatus String
Key vault sync status
cloudWitnessContainerName string
The Container for cloud witness in the storage account.
cloudWitnessStorageAccountName string
The Cloud Witness Storage account name.
cloudWitnessStorageEndpoint string
The Azure service endpoint of the cloud witness storage account.
clusterWitnessType string
Cluster Witness Type
deviceSecrets {[key: string]: SecretResponse}
Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
fileShareWitnessLocation string
The witness location of file share.
fileShareWitnessUsername string
The username of file share.
id string
The path ID that uniquely identifies the object.
name string
The object name.
resourceKey string
The Resource ID of the Resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of DataBoxEdgeDevice
type string
The hierarchical type of the object.
channelIntegrityKeyName string
The name of Channel Integrity Key stored in the Client Key Vault
channelIntegrityKeyVersion string
The version of Channel Integrity Key stored in the Client Key Vault
clientSecretStoreId string
The Key Vault ARM Id for client secrets
clientSecretStoreUrl string
The url to access the Client Key Vault
encryptionKey string
The public part of the encryption certificate. Client uses this to encrypt any secret.
encryptionKeyThumbprint string
The digital signature of encrypted certificate.
keyVaultSyncStatus string
Key vault sync status
cloud_witness_container_name str
The Container for cloud witness in the storage account.
cloud_witness_storage_account_name str
The Cloud Witness Storage account name.
cloud_witness_storage_endpoint str
The Azure service endpoint of the cloud witness storage account.
cluster_witness_type str
Cluster Witness Type
device_secrets Mapping[str, SecretResponse]
Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
file_share_witness_location str
The witness location of file share.
file_share_witness_username str
The username of file share.
id str
The path ID that uniquely identifies the object.
name str
The object name.
resource_key str
The Resource ID of the Resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of DataBoxEdgeDevice
type str
The hierarchical type of the object.
channel_integrity_key_name str
The name of Channel Integrity Key stored in the Client Key Vault
channel_integrity_key_version str
The version of Channel Integrity Key stored in the Client Key Vault
client_secret_store_id str
The Key Vault ARM Id for client secrets
client_secret_store_url str
The url to access the Client Key Vault
encryption_key str
The public part of the encryption certificate. Client uses this to encrypt any secret.
encryption_key_thumbprint str
The digital signature of encrypted certificate.
key_vault_sync_status str
Key vault sync status
cloudWitnessContainerName String
The Container for cloud witness in the storage account.
cloudWitnessStorageAccountName String
The Cloud Witness Storage account name.
cloudWitnessStorageEndpoint String
The Azure service endpoint of the cloud witness storage account.
clusterWitnessType String
Cluster Witness Type
deviceSecrets Map<Property Map>
Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
fileShareWitnessLocation String
The witness location of file share.
fileShareWitnessUsername String
The username of file share.
id String
The path ID that uniquely identifies the object.
name String
The object name.
resourceKey String
The Resource ID of the Resource.
systemData Property Map
Metadata pertaining to creation and last modification of DataBoxEdgeDevice
type String
The hierarchical type of the object.
channelIntegrityKeyName String
The name of Channel Integrity Key stored in the Client Key Vault
channelIntegrityKeyVersion String
The version of Channel Integrity Key stored in the Client Key Vault
clientSecretStoreId String
The Key Vault ARM Id for client secrets
clientSecretStoreUrl String
The url to access the Client Key Vault
encryptionKey String
The public part of the encryption certificate. Client uses this to encrypt any secret.
encryptionKeyThumbprint String
The digital signature of encrypted certificate.
keyVaultSyncStatus String
Key vault sync status

Supporting Types

AsymmetricEncryptedSecretResponse

EncryptionAlgorithm This property is required. string
The algorithm used to encrypt "Value".
Value This property is required. string
The value of the secret.
EncryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
EncryptionAlgorithm This property is required. string
The algorithm used to encrypt "Value".
Value This property is required. string
The value of the secret.
EncryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. String
The algorithm used to encrypt "Value".
value This property is required. String
The value of the secret.
encryptionCertThumbprint String
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. string
The algorithm used to encrypt "Value".
value This property is required. string
The value of the secret.
encryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryption_algorithm This property is required. str
The algorithm used to encrypt "Value".
value This property is required. str
The value of the secret.
encryption_cert_thumbprint str
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. String
The algorithm used to encrypt "Value".
value This property is required. String
The value of the secret.
encryptionCertThumbprint String
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

SecretResponse

EncryptedSecret Pulumi.AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecretResponse
Encrypted (using device public key) secret value.
KeyVaultId string
Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
EncryptedSecret AsymmetricEncryptedSecretResponse
Encrypted (using device public key) secret value.
KeyVaultId string
Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
encryptedSecret AsymmetricEncryptedSecretResponse
Encrypted (using device public key) secret value.
keyVaultId String
Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
encryptedSecret AsymmetricEncryptedSecretResponse
Encrypted (using device public key) secret value.
keyVaultId string
Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
encrypted_secret AsymmetricEncryptedSecretResponse
Encrypted (using device public key) secret value.
key_vault_id str
Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
encryptedSecret Property Map
Encrypted (using device public key) secret value.
keyVaultId String
Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).

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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
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 timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi