storage_account_credentials

Creates, updates, deletes, gets or lists a storage_account_credentials resource.

Overview

Name	storage_account_credentials
Type	Resource
Id	azure.data_box_edge.storage_account_credentials

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountKey	object	Encrypted storage key.
accountType	string	Type of storage accessed on the storage account. Required. Known values are: "GeneralPurposeStorage" and "BlobStorage". (GeneralPurposeStorage, BlobStorage)
alias	string	Alias for the storage account. Required.
blobDomainName	string	Blob end point for private clouds.
connectionString	string	Connection string for the storage account. Use this string if username and account key are not specified.
sslStatus	string	Signifies whether SSL needs to be enabled or not. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageAccountId	string	Id of the storage account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userName	string	Username for the storage account.

list_by_data_box_edge_device

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountKey	object	Encrypted storage key.
accountType	string	Type of storage accessed on the storage account. Required. Known values are: "GeneralPurposeStorage" and "BlobStorage". (GeneralPurposeStorage, BlobStorage)
alias	string	Alias for the storage account. Required.
blobDomainName	string	Blob end point for private clouds.
connectionString	string	Connection string for the storage account. Use this string if username and account key are not specified.
sslStatus	string	Signifies whether SSL needs to be enabled or not. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageAccountId	string	Id of the storage account.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userName	string	Username for the storage account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	device_name, name, resource_group_name, subscription_id		Gets the properties of the specified storage account credential.
list_by_data_box_edge_device	select	device_name, resource_group_name, subscription_id		Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device. Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.
create_or_update	insert	device_name, name, resource_group_name, subscription_id, properties		Creates or updates the storage account credential.
create_or_update	replace	device_name, name, resource_group_name, subscription_id, properties		Creates or updates the storage account credential.
delete	delete	device_name, name, resource_group_name, subscription_id		Deletes the storage account credential.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
device_name	string	The device name. Required.
name	string	The storage account credential name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the properties of the specified storage account credential.

SELECT
id,
name,
accountKey,
accountType,
alias,
blobDomainName,
connectionString,
sslStatus,
storageAccountId,
systemData,
type,
userName
FROM azure.data_box_edge.storage_account_credentials
WHERE device_name = '{{ device_name }}' -- required
AND name = '{{ name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_data_box_edge_device

Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device. Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.

SELECT
id,
name,
accountKey,
accountType,
alias,
blobDomainName,
connectionString,
sslStatus,
storageAccountId,
systemData,
type,
userName
FROM azure.data_box_edge.storage_account_credentials
WHERE device_name = '{{ device_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the storage account credential.

INSERT INTO azure.data_box_edge.storage_account_credentials (
properties,
device_name,
name,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ device_name }}',
'{{ name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_account_credentials
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the storage_account_credentials resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the storage_account_credentials resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the storage_account_credentials resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the storage_account_credentials resource.
  - name: properties
    description: |
      The storage account credential properties. Required.
    value:
      alias: "{{ alias }}"
      userName: "{{ userName }}"
      accountKey:
        value: "{{ value }}"
        encryptionCertThumbprint: "{{ encryptionCertThumbprint }}"
        encryptionAlgorithm: "{{ encryptionAlgorithm }}"
      connectionString: "{{ connectionString }}"
      sslStatus: "{{ sslStatus }}"
      blobDomainName: "{{ blobDomainName }}"
      accountType: "{{ accountType }}"
      storageAccountId: "{{ storageAccountId }}"

REPLACE examples

create_or_update

Creates or updates the storage account credential.

REPLACE azure.data_box_edge.storage_account_credentials
SET 
properties = '{{ properties }}'
WHERE 
device_name = '{{ device_name }}' --required
AND name = '{{ name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the storage account credential.

DELETE FROM azure.data_box_edge.storage_account_credentials
WHERE device_name = '{{ device_name }}' --required
AND name = '{{ name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;