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

The storage account credential properties.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The storage account credential properties.
systemData	object	Metadata pertaining to creation and last modification of StorageAccountCredential
type	string	The hierarchical type of the object.

list_by_data_box_edge_device

The collection of storage account credentials.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The storage account credential properties.
systemData	object	Metadata pertaining to creation and last modification of StorageAccountCredential
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, name, subscriptionId, resourceGroupName		Gets the properties of the specified storage account credential.
list_by_data_box_edge_device	select	deviceName, subscriptionId, resourceGroupName
create_or_update	insert	deviceName, name, subscriptionId, resourceGroupName, data__properties		Creates or updates the storage account credential.
delete	delete	deviceName, name, subscriptionId, resourceGroupName		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
deviceName	string	The device name.
name	string	The storage account credential name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.

SELECT examples

get

Gets the properties of the specified storage account credential.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.storage_account_credentials
WHERE deviceName = '{{ deviceName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_data_box_edge_device

The collection of storage account credentials.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.storage_account_credentials
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the storage account credential.

INSERT INTO azure.data_box_edge.storage_account_credentials (
data__properties,
deviceName,
name,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ name }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: storage_account_credentials
  props:
    - name: deviceName
      value: string
      description: Required parameter for the storage_account_credentials resource.
    - name: name
      value: string
      description: Required parameter for the storage_account_credentials resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the storage_account_credentials resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the storage_account_credentials resource.
    - name: properties
      value: object
      description: |
        The storage account credential properties.

DELETE examples

delete

Deletes the storage account credential.

DELETE FROM azure.data_box_edge.storage_account_credentials
WHERE deviceName = '{{ deviceName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;