az databoxedge device storage-account-credential

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage device storage account credential.

Commands

Name	Description	Type	Status
az databoxedge device storage-account-credential create	Create the storage account credential.	Core	Preview
az databoxedge device storage-account-credential delete	Delete the storage account credential.	Core	Preview
az databoxedge device storage-account-credential list	List all the storage account credentials in a Data Box Edge/Data Box Gateway device.	Core	Preview
az databoxedge device storage-account-credential show	Get the properties of the specified storage account credential.	Core	Preview
az databoxedge device storage-account-credential update	Update the storage account credential.	Core	Preview

az databoxedge device storage-account-credential create

Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the storage account credential.

az databoxedge device storage-account-credential create --account-type {BlobStorage, GeneralPurposeStorage}
                                                        --alias
                                                        --device-name
                                                        --name
                                                        --resource-group
                                                        --ssl-status {Disabled, Enabled}
                                                        [--account-key]
                                                        [--blob-domain-name]
                                                        [--connection-string]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--storage-account-id]
                                                        [--user-name]

Examples

Create storage account credential

az databoxedge device storage-account-credential create --device-name name -n sac-name -g rg --account-type GeneralPurposeStorage --alias testsac --ssl-status Enabled --account-key "{encryptionAlgorithm:AES256,value:xxx,encryptionCertThumbprint:xxx}"

Required Parameters

--account-type

Type of storage accessed on the storage account.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	BlobStorage, GeneralPurposeStorage

--alias

Alias for the storage account.

Property	Value
Parameter group:	Properties Arguments

--device-name

The device name.

--name -n

The storage account credential name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--ssl-status

Signifies whether SSL needs to be enabled or not.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-key

Encrypted storage key. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--blob-domain-name

Blob end point for private clouds.

Property	Value
Parameter group:	Properties Arguments

--connection-string

Connection string for the storage account. Use this string if username and account key are not specified.

Property	Value
Parameter group:	Properties Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--storage-account-id

Id of the storage account.

Property	Value
Parameter group:	Properties Arguments

--user-name

Username for the storage account.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az databoxedge device storage-account-credential delete

Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the storage account credential.

az databoxedge device storage-account-credential delete [--device-name]
                                                        [--ids]
                                                        [--name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--yes]

Examples

Delete storage account credential

az databoxedge device storage-account-credential delete --device-name name -n sac-name -g rg

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device-name

The device name.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The storage account credential name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az databoxedge device storage-account-credential list

Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

az databoxedge device storage-account-credential list --device-name
                                                      --resource-group
                                                      [--max-items]
                                                      [--next-token]

Examples

List storage account credential

az databoxedge device storage-account-credential list --device-name name -g rg

Required Parameters

--device-name

The device name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az databoxedge device storage-account-credential show

Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the properties of the specified storage account credential.

az databoxedge device storage-account-credential show [--device-name]
                                                      [--ids]
                                                      [--name]
                                                      [--resource-group]
                                                      [--subscription]

Examples

Show storage account credential

az databoxedge device storage-account-credential show --device-name name -n sac-name -g rg

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device-name

The device name.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The storage account credential name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az databoxedge device storage-account-credential update

Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the storage account credential.

az databoxedge device storage-account-credential update [--account-key]
                                                        [--account-type {BlobStorage, GeneralPurposeStorage}]
                                                        [--add]
                                                        [--alias]
                                                        [--blob-domain-name]
                                                        [--connection-string]
                                                        [--device-name]
                                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--ids]
                                                        [--name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--remove]
                                                        [--resource-group]
                                                        [--set]
                                                        [--ssl-status {Disabled, Enabled}]
                                                        [--storage-account-id]
                                                        [--subscription]
                                                        [--user-name]

Examples

Update storage account credential

az databoxedge device storage-account-credential update --device-name name -n sac-name -g rg --account-type GeneralPurposeStorage --alias testsac --ssl-status Enabled --account-key "{encryptionAlgorithm:AES256,value:xxx,encryptionCertThumbprint:xxx}"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-key

Encrypted storage key. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--account-type

Type of storage accessed on the storage account.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	BlobStorage, GeneralPurposeStorage

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--alias

Alias for the storage account.

Property	Value
Parameter group:	Properties Arguments

--blob-domain-name

Blob end point for private clouds.

Property	Value
Parameter group:	Properties Arguments

--connection-string

Connection string for the storage account. Use this string if username and account key are not specified.

Property	Value
Parameter group:	Properties Arguments

--device-name

The device name.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The storage account credential name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--ssl-status

Signifies whether SSL needs to be enabled or not.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--storage-account-id

Id of the storage account.

Property	Value
Parameter group:	Properties Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--user-name

Username for the storage account.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False