azure-native.databoxedge.getDeviceExtendedInformation
Explore with Pulumi AI
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>
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]
func GetDeviceExtendedInformation(ctx *Context, args *GetDeviceExtendedInformationArgs, opts ...InvokeOption) (*GetDeviceExtendedInformationResult, error)
func GetDeviceExtendedInformationOutput(ctx *Context, args *GetDeviceExtendedInformationOutputArgs, opts ...InvokeOption) GetDeviceExtendedInformationResultOutput
> 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)
}
public static CompletableFuture<GetDeviceExtendedInformationResult> getDeviceExtendedInformation(GetDeviceExtendedInformationArgs args, InvokeOptions options)
public static Output<GetDeviceExtendedInformationResult> getDeviceExtendedInformation(GetDeviceExtendedInformationArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:databoxedge:getDeviceExtendedInformation
arguments:
# arguments dictionary
The following arguments are supported:
- Device
Name string - The device name.
- Resource
Group stringName - The resource group name.
- Device
Name string - The device name.
- Resource
Group stringName - The resource group name.
- device
Name String - The device name.
- resource
Group StringName - The resource group name.
- device
Name string - The device name.
- resource
Group stringName - The resource group name.
- device_
name str - The device name.
- resource_
group_ strname - The resource group name.
- device
Name String - The device name.
- resource
Group StringName - The resource group name.
getDeviceExtendedInformation Result
The following output properties are available:
- Cloud
Witness stringContainer Name - The Container for cloud witness in the storage account.
- Cloud
Witness stringStorage Account Name - The Cloud Witness Storage account name.
- Cloud
Witness stringStorage Endpoint - The Azure service endpoint of the cloud witness storage account.
- Cluster
Witness stringType - Cluster Witness Type
- Device
Secrets Dictionary<string, Pulumi.Azure Native. Data Box Edge. Outputs. Secret Response> - Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
- string
- The witness location of file share.
- string
- The username of file share.
- Id string
- The path ID that uniquely identifies the object.
- Name string
- The object name.
- Resource
Key string - The Resource ID of the Resource.
- System
Data Pulumi.Azure Native. Data Box Edge. Outputs. System Data Response - Metadata pertaining to creation and last modification of DataBoxEdgeDevice
- Type string
- The hierarchical type of the object.
- Channel
Integrity stringKey Name - The name of Channel Integrity Key stored in the Client Key Vault
- Channel
Integrity stringKey Version - The version of Channel Integrity Key stored in the Client Key Vault
- Client
Secret stringStore Id - The Key Vault ARM Id for client secrets
- Client
Secret stringStore Url - The url to access the Client Key Vault
- Encryption
Key string - The public part of the encryption certificate. Client uses this to encrypt any secret.
- Encryption
Key stringThumbprint - The digital signature of encrypted certificate.
- Key
Vault stringSync Status - Key vault sync status
- Cloud
Witness stringContainer Name - The Container for cloud witness in the storage account.
- Cloud
Witness stringStorage Account Name - The Cloud Witness Storage account name.
- Cloud
Witness stringStorage Endpoint - The Azure service endpoint of the cloud witness storage account.
- Cluster
Witness stringType - Cluster Witness Type
- Device
Secrets map[string]SecretResponse - Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
- string
- The witness location of file share.
- string
- The username of file share.
- Id string
- The path ID that uniquely identifies the object.
- Name string
- The object name.
- Resource
Key string - The Resource ID of the Resource.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of DataBoxEdgeDevice
- Type string
- The hierarchical type of the object.
- Channel
Integrity stringKey Name - The name of Channel Integrity Key stored in the Client Key Vault
- Channel
Integrity stringKey Version - The version of Channel Integrity Key stored in the Client Key Vault
- Client
Secret stringStore Id - The Key Vault ARM Id for client secrets
- Client
Secret stringStore Url - The url to access the Client Key Vault
- Encryption
Key string - The public part of the encryption certificate. Client uses this to encrypt any secret.
- Encryption
Key stringThumbprint - The digital signature of encrypted certificate.
- Key
Vault stringSync Status - Key vault sync status
- cloud
Witness StringContainer Name - The Container for cloud witness in the storage account.
- cloud
Witness StringStorage Account Name - The Cloud Witness Storage account name.
- cloud
Witness StringStorage Endpoint - The Azure service endpoint of the cloud witness storage account.
- cluster
Witness StringType - Cluster Witness Type
- device
Secrets Map<String,SecretResponse> - Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
- String
- The witness location of file share.
- String
- The username of file share.
- id String
- The path ID that uniquely identifies the object.
- name String
- The object name.
- resource
Key String - The Resource ID of the Resource.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of DataBoxEdgeDevice
- type String
- The hierarchical type of the object.
- channel
Integrity StringKey Name - The name of Channel Integrity Key stored in the Client Key Vault
- channel
Integrity StringKey Version - The version of Channel Integrity Key stored in the Client Key Vault
- client
Secret StringStore Id - The Key Vault ARM Id for client secrets
- client
Secret StringStore Url - The url to access the Client Key Vault
- encryption
Key String - The public part of the encryption certificate. Client uses this to encrypt any secret.
- encryption
Key StringThumbprint - The digital signature of encrypted certificate.
- key
Vault StringSync Status - Key vault sync status
- cloud
Witness stringContainer Name - The Container for cloud witness in the storage account.
- cloud
Witness stringStorage Account Name - The Cloud Witness Storage account name.
- cloud
Witness stringStorage Endpoint - The Azure service endpoint of the cloud witness storage account.
- cluster
Witness stringType - Cluster Witness Type
- device
Secrets {[key: string]: SecretResponse} - Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
- string
- The witness location of file share.
- string
- The username of file share.
- id string
- The path ID that uniquely identifies the object.
- name string
- The object name.
- resource
Key string - The Resource ID of the Resource.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of DataBoxEdgeDevice
- type string
- The hierarchical type of the object.
- channel
Integrity stringKey Name - The name of Channel Integrity Key stored in the Client Key Vault
- channel
Integrity stringKey Version - The version of Channel Integrity Key stored in the Client Key Vault
- client
Secret stringStore Id - The Key Vault ARM Id for client secrets
- client
Secret stringStore Url - The url to access the Client Key Vault
- encryption
Key string - The public part of the encryption certificate. Client uses this to encrypt any secret.
- encryption
Key stringThumbprint - The digital signature of encrypted certificate.
- key
Vault stringSync Status - Key vault sync status
- cloud_
witness_ strcontainer_ name - The Container for cloud witness in the storage account.
- cloud_
witness_ strstorage_ account_ name - The Cloud Witness Storage account name.
- cloud_
witness_ strstorage_ endpoint - The Azure service endpoint of the cloud witness storage account.
- cluster_
witness_ strtype - Cluster Witness Type
- device_
secrets Mapping[str, SecretResponse] - Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
- str
- The witness location of file share.
- 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 SystemData Response - Metadata pertaining to creation and last modification of DataBoxEdgeDevice
- type str
- The hierarchical type of the object.
- channel_
integrity_ strkey_ name - The name of Channel Integrity Key stored in the Client Key Vault
- channel_
integrity_ strkey_ version - The version of Channel Integrity Key stored in the Client Key Vault
- client_
secret_ strstore_ id - The Key Vault ARM Id for client secrets
- client_
secret_ strstore_ url - 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_ strthumbprint - The digital signature of encrypted certificate.
- key_
vault_ strsync_ status - Key vault sync status
- cloud
Witness StringContainer Name - The Container for cloud witness in the storage account.
- cloud
Witness StringStorage Account Name - The Cloud Witness Storage account name.
- cloud
Witness StringStorage Endpoint - The Azure service endpoint of the cloud witness storage account.
- cluster
Witness StringType - Cluster Witness Type
- device
Secrets Map<Property Map> - Device secrets, will be returned only with ODataFilter $expand=deviceSecrets
- String
- The witness location of file share.
- String
- The username of file share.
- id String
- The path ID that uniquely identifies the object.
- name String
- The object name.
- resource
Key String - The Resource ID of the Resource.
- system
Data Property Map - Metadata pertaining to creation and last modification of DataBoxEdgeDevice
- type String
- The hierarchical type of the object.
- channel
Integrity StringKey Name - The name of Channel Integrity Key stored in the Client Key Vault
- channel
Integrity StringKey Version - The version of Channel Integrity Key stored in the Client Key Vault
- client
Secret StringStore Id - The Key Vault ARM Id for client secrets
- client
Secret StringStore Url - The url to access the Client Key Vault
- encryption
Key String - The public part of the encryption certificate. Client uses this to encrypt any secret.
- encryption
Key StringThumbprint - The digital signature of encrypted certificate.
- key
Vault StringSync Status - Key vault sync status
Supporting Types
AsymmetricEncryptedSecretResponse
- Encryption
Algorithm string - The algorithm used to encrypt "Value".
- Value string
- The value of the secret.
- Encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- Encryption
Algorithm string - The algorithm used to encrypt "Value".
- Value string
- The value of the secret.
- Encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm String - The algorithm used to encrypt "Value".
- value String
- The value of the secret.
- encryption
Cert StringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm string - The algorithm used to encrypt "Value".
- value string
- The value of the secret.
- encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption_
algorithm str - The algorithm used to encrypt "Value".
- value str
- The value of the secret.
- encryption_
cert_ strthumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm String - The algorithm used to encrypt "Value".
- value String
- The value of the secret.
- encryption
Cert StringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
SecretResponse
- Encrypted
Secret Pulumi.Azure Native. Data Box Edge. Inputs. Asymmetric Encrypted Secret Response - Encrypted (using device public key) secret value.
- Key
Vault stringId - Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
- Encrypted
Secret AsymmetricEncrypted Secret Response - Encrypted (using device public key) secret value.
- Key
Vault stringId - Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
- encrypted
Secret AsymmetricEncrypted Secret Response - Encrypted (using device public key) secret value.
- key
Vault StringId - Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
- encrypted
Secret AsymmetricEncrypted Secret Response - Encrypted (using device public key) secret value.
- key
Vault stringId - Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
- encrypted_
secret AsymmetricEncrypted Secret Response - Encrypted (using device public key) secret value.
- key_
vault_ strid - Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
- encrypted
Secret Property Map - Encrypted (using device public key) secret value.
- key
Vault StringId - Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740).
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0