Share via

Microsoft.DataBoxEdge dataBoxEdgeDevices/storageAccountCredentials 2019-03-01

  • Article

Bicep resource definition

The dataBoxEdgeDevices/storageAccountCredentials 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/storageAccountCredentials resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-03-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    accountKey: {
      encryptionAlgorithm: 'string'
      encryptionCertThumbprint: 'string'
      value: 'string'
    }
    accountType: 'string'
    alias: 'string'
    blobDomainName: 'string'
    connectionString: 'string'
    sslStatus: 'string'
    userName: 'string'
  }
}

Property values

dataBoxEdgeDevices/storageAccountCredentials

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 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. StorageAccountCredentialProperties (required)

StorageAccountCredentialProperties

Name Description Value
accountKey Encrypted storage key. AsymmetricEncryptedSecret
accountType Type of storage accessed on the storage account. 'BlobStorage'
'GeneralPurposeStorage' (required)
alias Alias for the storage account. string (required)
blobDomainName Blob end point for private clouds. string
connectionString Connection string for the storage account. Use this string if username and account key are not specified. string
sslStatus Signifies whether SSL needs to be enabled or not. 'Disabled'
'Enabled' (required)
userName Username for the storage account. string

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
value The value of the secret. string (required)

ARM template resource definition

The dataBoxEdgeDevices/storageAccountCredentials 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/storageAccountCredentials resource, add the following JSON to your template.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials",
  "apiVersion": "2019-03-01",
  "name": "string",
  "properties": {
    "accountKey": {
      "encryptionAlgorithm": "string",
      "encryptionCertThumbprint": "string",
      "value": "string"
    },
    "accountType": "string",
    "alias": "string",
    "blobDomainName": "string",
    "connectionString": "string",
    "sslStatus": "string",
    "userName": "string"
  }
}

Property values

dataBoxEdgeDevices/storageAccountCredentials

Name Description Value
type The resource type 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials'
apiVersion The resource api version '2019-03-01'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties The storage account credential properties. StorageAccountCredentialProperties (required)

StorageAccountCredentialProperties

Name Description Value
accountKey Encrypted storage key. AsymmetricEncryptedSecret
accountType Type of storage accessed on the storage account. 'BlobStorage'
'GeneralPurposeStorage' (required)
alias Alias for the storage account. string (required)
blobDomainName Blob end point for private clouds. string
connectionString Connection string for the storage account. Use this string if username and account key are not specified. string
sslStatus Signifies whether SSL needs to be enabled or not. 'Disabled'
'Enabled' (required)
userName Username for the storage account. string

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
value The value of the secret. string (required)

Terraform (AzAPI provider) resource definition

The dataBoxEdgeDevices/storageAccountCredentials 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/storageAccountCredentials resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-03-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      accountKey = {
        encryptionAlgorithm = "string"
        encryptionCertThumbprint = "string"
        value = "string"
      }
      accountType = "string"
      alias = "string"
      blobDomainName = "string"
      connectionString = "string"
      sslStatus = "string"
      userName = "string"
    }
  })
}

Property values

dataBoxEdgeDevices/storageAccountCredentials

Name Description Value
type The resource type "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@2019-03-01"
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. StorageAccountCredentialProperties (required)

StorageAccountCredentialProperties

Name Description Value
accountKey Encrypted storage key. AsymmetricEncryptedSecret
accountType Type of storage accessed on the storage account. "BlobStorage"
"GeneralPurposeStorage" (required)
alias Alias for the storage account. string (required)
blobDomainName Blob end point for private clouds. string
connectionString Connection string for the storage account. Use this string if username and account key are not specified. string
sslStatus Signifies whether SSL needs to be enabled or not. "Disabled"
"Enabled" (required)
userName Username for the storage account. string

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
value The value of the secret. string (required)