Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The dataBoxEdgeDevices/storageAccountCredentials resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2023-12-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
accountKey: {
encryptionAlgorithm: 'string'
encryptionCertThumbprint: 'string'
value: 'string'
}
accountType: 'string'
alias: 'string'
blobDomainName: 'string'
connectionString: 'string'
sslStatus: 'string'
storageAccountId: 'string'
userName: 'string'
}
}
Property Values
Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials
| 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. | StorageAccountCredentialProperties (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) |
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) |
| storageAccountId | Id of the storage account. | string |
| userName | Username for the storage account. | string |
ARM template resource definition
The dataBoxEdgeDevices/storageAccountCredentials resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials resource, add the following JSON to your template.
{
"type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials",
"apiVersion": "2023-12-01",
"name": "string",
"properties": {
"accountKey": {
"encryptionAlgorithm": "string",
"encryptionCertThumbprint": "string",
"value": "string"
},
"accountType": "string",
"alias": "string",
"blobDomainName": "string",
"connectionString": "string",
"sslStatus": "string",
"storageAccountId": "string",
"userName": "string"
}
}
Property Values
Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01' |
| name | The resource name | string (required) |
| properties | The storage account credential properties. | StorageAccountCredentialProperties (required) |
| type | The resource type | 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials' |
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) |
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) |
| storageAccountId | Id of the storage account. | string |
| userName | Username for the storage account. | string |
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@2023-12-01"
name = "string"
parent_id = "string"
body = {
properties = {
accountKey = {
encryptionAlgorithm = "string"
encryptionCertThumbprint = "string"
value = "string"
}
accountType = "string"
alias = "string"
blobDomainName = "string"
connectionString = "string"
sslStatus = "string"
storageAccountId = "string"
userName = "string"
}
}
}
Property Values
Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials
| 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. | StorageAccountCredentialProperties (required) |
| type | The resource type | "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials@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) |
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) |
| storageAccountId | Id of the storage account. | string |
| userName | Username for the storage account. | string |