Registration command of the Storage Authentication Information (Azure Blob Storage)

Parameter explanation

[COMMON-OPTIONS]

These options are common to all utilities.

-r, --replace

Replacement (optional)

This parameter overwrites the existing Storage Authentication Information.

If you try to overwrite the existing Storage Management Information without specifying this option, an error occurs.

Note

To overwrite the existing Storage Authentication Information, specify the value that is already set with the [AUTH-OPTIONS].

If the information that is already set is not specified again, it is overwritten with the value "Use the default value.".

-f, --force

Omission of confirmation (optional)

This parameter registers information without confirmation of the registered information.

When you specify the existing Storage Authentication Information, the information is overwritten even if you do not specify "-r" or "--replace".

When you omit it, the following confirmation message is output before registration of the Storage Authentication Information:

Are you sure to register? [y/n]:

Input "y" or "Y" to register the Storage Authentication Information specified by the command.

Input other than "y" or "Y" ends in an error.

[REQUIRED]

These parameters cannot be omitted.

-t, --type auth

Type of information (mandatory)

auth:

Storage Authentication Information

--id ID

ID (mandatory)

This ID identifies the Storage Authentication Information.

Specify from 3 to 63 bytes of ASCII printable characters.

If you include single-byte spaces, "/", or "*", an error occurs.

[AUTH-OPTIONS]

These options set the Storage Authentication Information.

Note

If you specify "Enable managed ID (--enable-managed-id)", you must specify "Azure storage account (--storage-account ACCOUNT)". You cannot specify "Azure storage SAS token (--storage-sas-token TOKEN)" and "Azure storage key (--storage-key KEY)".

Authentication that uses either an Azure storage SAS token or an Azure storage key is called "Shared Key authentication".

When you use "Shared Key" authentication, set either the Azure storage account or Azure storage SAS token.

If both are set, only the value for Azure storage SAS token is used.

For details on the priority of use for "Shared Key authentication" that uses an Azure storage SAS token or an Azure storage key and "Enable managed ID", refer to Storage Authentication Information settings.

--storage-account ACCOUNT

Azure storage account (optional)

This parameter specifies the storage account name of the user who performs the upload in order to connect to Microsoft Azure.

Specify up to 255 bytes of ASCII printable characters.

When you omit specification of this option, the value "Use the default value." is set. In this case, the value set in the default information is used during transfer.

--storage-sas-token TOKEN

Azure storage SAS token (optional)

This parameter specifies the token for access control in order to connect to Microsoft Azure.

Specify up to 255 bytes of ASCII printable characters.

When you omit specification of this option, the value "Use the default value." is set. In this case, the value set in the default information is used during transfer.

--storage-key KEY

Azure storage key (optional)

This parameter specifies the primary or secondary access key for the storage account name of the user who performs the upload in order to connect to Microsoft Azure.

Specify up to 255 bytes of ASCII printable characters.

When you omit specification of this option, the value "Use the default value." is set. In this case, the value set in the default information is used during transfer.

--enable-managed-id

Enable managed ID (optional)

This parameter specifies whether to enable authentication with a managed identity assigned to the Azure resource (Azure VM) in order to connect to Microsoft Azure.

When you specify this parameter, authentication with a managed identity is enabled. In this case, the authentication information associated with Azure Active Directory (Azure AD) is used.

When you omit specification of this option, the value "Use the default value." is set. In this case, the value set in the default information is used during transfer.

= Remarks =

If HULFT and HULFT Cloud Storage Option have been installed in an environment other than Azure resource (Azure VM), transfer results in an error if you enable the managed identity.

Supplement

• As shown below, you can specify either with a space or an equals sign (=) between the parameter and the setting value.

    --parameter Value 
    --parameter=Value

• If you specify "-h" or "--help" for the parameter, the usage is output.