table of contents
AZURECTL(1) | AZURECTL(1) |
NAME¶
azurectl - Command Line Interface to manage Microsoft Azure
Configuration file setup for azurectl.
SYNOPSIS¶
azurectl setup account configure --name=account_name --publish-settings-file=file
-
[--subscription-id=subscriptionid] [--region=region_name --storage-account-name=storagename --container-name=containername --create]
azurectl setup account configure --name=account_name --management-pem-file=file --management-url=url --subscription-id=subscriptionid
-
[--region=region_name --storage-account-name=storagename --container-name=containername --create]
azurectl setup account list
azurectl setup account default --name=account_name
azurectl setup account remove --name=account_name
DESCRIPTION¶
configure¶
Create new account configuration file
default¶
Create a default configuration which is a symlink to the specified account configuration file. If there is already a default configuration which is not a symlink to an account configuration, the call will fail with an error message.
list¶
List configured account names. If no config file is specified all commands will use the default config file searched in:
- 1.
- ~/.config/azurectl/config
- 2.
- ~/.azurectl/config
remove¶
Remove the referenced account configuration file
OPTIONS¶
--container-name=containername¶
The name of the container which must exist in the configured storage account.
--create¶
Optional paramter for the account configuration. Allows to create the storage account and its container in Azure.
--management-pem-file=file¶
If a management certificate has been created for this account, specify the absolute path of the pem file used to create the certificate.
--management-url=url¶
If a management certificate is being used in lieu of a publish settings file, the URL of the management API needs to be specified manually as well.
Common URLs are:
- •
- Azure: https://management.core.windows.net
- •
- Azure China (Mooncake): https://management.core.chinacloudapi.cn
- •
- Azure Black Forest: https://management.core.cloudapi.de
--name=account_name¶
Free form name for the azure account to use. The name is used to find the corresponding configuration file.
--publish-settings-file=file¶
The path to the Microsoft Azure publish settings file which you can download from the Microsoft management console.
--subscription-id=subscriptionid¶
If your Microsoft Azure account includes more than one subscription, your publish setttings file will contain data about all of your subscriptions. Specify a subscriptionid in order to select the appropriate subscription.
If subscriptionid is not supplied the first subscription listed in the publish settings file will be selected by default.
If using a management certificate, a subscriptionid must be supplied.
--storage-account-name=storagename¶
The name of the storage account which must exist in the configured region.
--region=region¶
Name of the geographic region in Azure.
AZURECTL User Manuals |