Microsoft.DataBoxEdge dataBoxEdgeDevices/users

Bicep resource definition

The dataBoxEdgeDevices/users resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/users resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2023-12-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    encryptedPassword: {
      encryptionAlgorithm: 'string'
      encryptionCertThumbprint: 'string'
      value: 'string'
    }
    userType: 'string'
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/users

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: dataBoxEdgeDevices
properties The storage account credential properties. UserProperties (required)

AsymmetricEncryptedSecret

Name Description Value
encryptionAlgorithm The algorithm used to encrypt "Value". 'AES256'
'None'
'RSAES_PKCS1_v_1_5' (required)
encryptionCertThumbprint Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null. string

Constraints:
Sensitive value. Pass in as a secure parameter.
value The value of the secret. string (required)

UserProperties

Name Description Value
encryptedPassword The password details. AsymmetricEncryptedSecret
userType Type of the user. 'ARM'
'LocalManagement'
'Share' (required)

ARM template resource definition

The dataBoxEdgeDevices/users resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/users resource, add the following JSON to your template.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users",
  "apiVersion": "2023-12-01",
  "name": "string",
  "properties": {
    "encryptedPassword": {
      "encryptionAlgorithm": "string",
      "encryptionCertThumbprint": "string",
      "value": "string"
    },
    "userType": "string"
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/users

Name Description Value
apiVersion The api version '2023-12-01'
name The resource name string (required)
properties The storage account credential properties. UserProperties (required)
type The resource type 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/users'

AsymmetricEncryptedSecret

Name Description Value
encryptionAlgorithm The algorithm used to encrypt "Value". 'AES256'
'None'
'RSAES_PKCS1_v_1_5' (required)
encryptionCertThumbprint Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null. string

Constraints:
Sensitive value. Pass in as a secure parameter.
value The value of the secret. string (required)

UserProperties

Name Description Value
encryptedPassword The password details. AsymmetricEncryptedSecret
userType Type of the user. 'ARM'
'LocalManagement'
'Share' (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The dataBoxEdgeDevices/users resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/users resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2023-12-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      encryptedPassword = {
        encryptionAlgorithm = "string"
        encryptionCertThumbprint = "string"
        value = "string"
      }
      userType = "string"
    }
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/users

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: dataBoxEdgeDevices
properties The storage account credential properties. UserProperties (required)
type The resource type "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users@2023-12-01"

AsymmetricEncryptedSecret

Name Description Value
encryptionAlgorithm The algorithm used to encrypt "Value". 'AES256'
'None'
'RSAES_PKCS1_v_1_5' (required)
encryptionCertThumbprint Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null. string

Constraints:
Sensitive value. Pass in as a secure parameter.
value The value of the secret. string (required)

UserProperties

Name Description Value
encryptedPassword The password details. AsymmetricEncryptedSecret
userType Type of the user. 'ARM'
'LocalManagement'
'Share' (required)
  • Last updated on