PrivacyScanData/Azure/AzureStorage/docs/credentials.md

AzureCredentials

AzureCredentials allows you to store, modify, or delete your Azure account name and connection string in the system keyring

Choose either the store or delete functionality

Find your connection string

Find your account key

General Usage

usage: AzureCredentials [-h] {store,delete} ...

Set, modify, or delete Azure storage credentials in the system keyring

optional arguments:
  -h, --help      show this help message and exit

Available functionality:
  {store,delete}
    store         Store or update Azure storage credentials in the system keyring
    delete        Delete Azure storage credentials in the system keyring

Azure credentials store

Store or modify your account name and connection string in the system keyring

Required arguments:

• account name

Optional arguments:

• passphrase used to store your connection string in the system keyring (default is AzureStorage)
• verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info

Example commands:

To store the account name account_name and your connection string in the system keyring

AzureCredentials store -a account_name

NOTE: You will be prompted to enter your connection string by the script. Note that, as a security precaution, you will not see the text you entered.

To store the account name account_name and your connection string in the system keyring using the passphrase passphrase

AzureCredentials store -a account_name -p passphrase

NOTE: You will be prompted to enter your connection string by the script. Note that, as a security precaution, you will not see the text you entered.

Usage

usage: AzureCredentials store [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY]

Store or update Azure storage credentials in the system keyring

optional arguments:
  -h, --help            show this help message and exit
  -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
                        Name of the Azure storage account
  -p PASSPHRASE, --passphrase PASSPHRASE
                        The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is "AzureStorage".
  -v VERBOSITY, --verbosity VERBOSITY
                        Set the logging level. Options are debug, info, warning, error, and critical. Default is info.

Azure credentials delete

Delete your account name and connection string from the system keyring

Required arguments:

• account name

Optional arguments:

• passphrase used to store your connection string in the system keyring (default is AzureStorage)
• verbosity: set the logging level. Options are debug,info,warning,error,critical. Default is info

Example command:

To delete the account name account_name and your connection string from the system keyring

AzureCredentials delete -a account_name

NOTE: You will be prompted to enter your connection string by the script. Note that, as a security precaution, you will not see the text you entered.

To delete the account name account_name and your connection string from the system keyring stored using the passphrase passphrase

AzureCredentials delete -a account_name -p passphrase

NOTE: You will be prompted to enter your connection string by the script. Note that, as a security precaution, you will not see the text you entered.

Usage

usage: AzureCredentials delete [-h] -a ACCOUNT_NAME [-p PASSPHRASE] [-v VERBOSITY]

Delete Azure storage credentials in the system keyring

optional arguments:
  -h, --help            show this help message and exit
  -a ACCOUNT_NAME, --account_name ACCOUNT_NAME
                        Name of the Azure storage account
  -p PASSPHRASE, --passphrase PASSPHRASE
                        The passphrase to use when encrypting the azure storage-specific connection string to the system keyring. Default is "AzureStorage".
  -v VERBOSITY, --verbosity VERBOSITY
                        Set the logging level. Options are debug, info, warning, error, and critical. Default is info.