{ "fullName": null, "usage": "[options] [command]", "options": [ { "flags": "-v, --version", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--version", "description": "output the application version" } ], "commands": [ { "name": "help", "description": "Display help for a given command", "fullName": "help", "usage": "[options] [command]", "filePath": "commands/help.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] }, { "name": "login", "description": "Log in to an Azure subscription using Active Directory or a Microsoft account identity.", "fullName": "login", "usage": "[options]", "filePath": "commands/login.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-u --username ", "required": -15, "optional": 0, "bool": true, "short": "-u", "long": "--username", "description": "user name or service principal ID. If multifactor authentication is required, you will be prompted to use the login command without parameters for interactive support." }, { "flags": "-e --environment [environment]", "required": 0, "optional": -18, "bool": true, "short": "-e", "long": "--environment", "description": "Environment to authenticate against, such as AzureChinaCloud; must support Active Directory." }, { "flags": "-p --password ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "user password or service principal secret, will prompt if not given." }, { "flags": "--service-principal", "required": 0, "optional": 0, "bool": true, "long": "--service-principal", "description": "If given, log in as a service principal rather than a user." }, { "flags": "--certificate-file ", "required": -20, "optional": 0, "bool": true, "long": "--certificate-file", "description": "A PEM encoded certificate private key file." }, { "flags": "--thumbprint ", "required": -14, "optional": 0, "bool": true, "long": "--thumbprint", "description": "A hex encoded thumbprint of the certificate." }, { "flags": "--tenant ", "required": -10, "optional": 0, "bool": true, "long": "--tenant", "description": "Tenant domain or ID to log into." }, { "flags": "-q --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "do not prompt for confirmation of PII storage." } ] }, { "name": "logout", "description": "Log out from Azure subscription using Active Directory. Currently, the user can log out only via Microsoft organizational account", "fullName": "logout", "usage": "[options] [username]", "filePath": "commands/login.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-u --username ", "required": -15, "optional": 0, "bool": true, "short": "-u", "long": "--username", "description": "Required. User name used to log out from Azure Active Directory." } ] }, { "name": "portal", "description": "Open the portal in a browser", "fullName": "portal", "usage": "[options]", "filePath": "commands/portal.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-e, --environment ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--environment", "description": "the publish settings download environment" }, { "flags": "-r, --realm ", "required": -13, "optional": 0, "bool": true, "short": "-r", "long": "--realm", "description": "the organization's realm" } ] }, { "name": "telemetry", "description": "Manages the data collection preference.", "fullName": "telemetry", "usage": "[options]", "filePath": "commands/telemetry.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-e, --enable", "required": 0, "optional": 0, "bool": true, "short": "-e", "long": "--enable", "description": "use this flag to enable telemetry" }, { "flags": "-d, --disable", "required": 0, "optional": 0, "bool": true, "short": "-d", "long": "--disable", "description": "use this flag to disable telemetry" } ] } ], "categories": { "account": { "name": "account", "description": "Commands to manage your account information and publish settings", "fullName": "account", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List the imported subscriptions", "fullName": "account list", "usage": "[options]", "filePath": "commands/account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] }, { "name": "show", "description": "Show details about a subscription", "fullName": "account show", "usage": "[options] [subscriptionNameOrId]", "filePath": "commands/account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-s --subscriptionNameOrId ", "required": -27, "optional": 0, "bool": true, "short": "-s", "long": "--subscriptionNameOrId", "description": "The subscription to show" }, { "flags": "-d --details", "required": 0, "optional": 0, "bool": true, "short": "-d", "long": "--details", "description": "Show extra information about the subscription" } ] }, { "name": "set", "description": "Set the current subscription", "fullName": "account set", "usage": "[options] ", "filePath": "commands/account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] }, { "name": "clear", "description": "Remove a subscription or environment, or clear all of the stored account and environment info", "fullName": "account clear", "usage": "[options]", "filePath": "commands/account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-s --subscription ", "required": -19, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "Subscription name or id to remove" }, { "flags": "-e --environment ", "required": -18, "optional": 0, "bool": true, "short": "-e", "long": "--environment", "description": "Environment name to remove" }, { "flags": "-q --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for delete confirmation" } ] } ], "categories": { "env": { "name": "env", "description": "Commands to manage your account environment", "fullName": "account env", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List the environments", "fullName": "account env list", "usage": "[options]", "filePath": "commands/account.environment.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] }, { "name": "show", "description": "Show an environment", "fullName": "account env show", "usage": "[options] [environment]", "filePath": "commands/account.environment.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--environment ", "required": -15, "optional": 0, "bool": true, "long": "--environment", "description": "the environment name" } ] }, { "name": "add", "description": "Add an environment", "fullName": "account env add", "usage": "[options] [environment]", "filePath": "commands/account.environment.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--environment ", "required": -15, "optional": 0, "bool": true, "long": "--environment", "description": "the environment name" }, { "flags": "--portal-url ", "required": -14, "optional": 0, "bool": true, "long": "--portal-url", "description": "the management portal URL" }, { "flags": "--azure-data-lake-analytics-catalog-and-job-endpoint-suffix ", "required": -61, "optional": 0, "bool": true, "long": "--azure-data-lake-analytics-catalog-and-job-endpoint-suffix", "description": "the data lake analytics job and catalog service dns suffix" }, { "flags": "--management-endpoint-url ", "required": -27, "optional": 0, "bool": true, "long": "--management-endpoint-url", "description": "the management service endpoint" }, { "flags": "--resource-manager-endpoint-url ", "required": -33, "optional": 0, "bool": true, "long": "--resource-manager-endpoint-url", "description": "the resource management endpoint" }, { "flags": "--sql-management-endpoint-url ", "required": -31, "optional": 0, "bool": true, "long": "--sql-management-endpoint-url", "description": "the sql server management endpoint for mobile commands" }, { "flags": "--sql-server-hostname-suffix ", "required": -30, "optional": 0, "bool": true, "long": "--sql-server-hostname-suffix", "description": "the dns suffix for sql servers" }, { "flags": "--active-directory-endpoint-url ", "required": -33, "optional": 0, "bool": true, "long": "--active-directory-endpoint-url", "description": "the Active Directory login endpoint" }, { "flags": "--publishing-profile-url ", "required": -26, "optional": 0, "bool": true, "long": "--publishing-profile-url", "description": "the publish settings file URL" }, { "flags": "--gallery-endpoint-url ", "required": -24, "optional": 0, "bool": true, "long": "--gallery-endpoint-url", "description": "the template gallery endpoint" }, { "flags": "--active-directory-graph-resource-id ", "required": -38, "optional": 0, "bool": true, "long": "--active-directory-graph-resource-id", "description": "the Active Directory resource ID" }, { "flags": "--active-directory-graph-api-version ", "required": -38, "optional": 0, "bool": true, "long": "--active-directory-graph-api-version", "description": "the Active Directory api version" }, { "flags": "--storage-endpoint-suffix ", "required": -27, "optional": 0, "bool": true, "long": "--storage-endpoint-suffix", "description": "the endpoint suffix for storage accounts" }, { "flags": "--key-vault-dns-suffix ", "required": -24, "optional": 0, "bool": true, "long": "--key-vault-dns-suffix", "description": "the keyvault service dns suffix" }, { "flags": "--azure-data-lake-store-file-system-endpoint-suffix ", "required": -53, "optional": 0, "bool": true, "long": "--azure-data-lake-store-file-system-endpoint-suffix", "description": "the data lake store filesystem service dns suffix" }, { "flags": "--active-directory-resource-id ", "required": -32, "optional": 0, "bool": true, "long": "--active-directory-resource-id", "description": "The resource ID to obtain AD tokens for" } ] }, { "name": "set", "description": "Update an environment", "fullName": "account env set", "usage": "[options] [environment]", "filePath": "commands/account.environment.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--environment ", "required": -15, "optional": 0, "bool": true, "long": "--environment", "description": "the environment name" }, { "flags": "--portal-url ", "required": -14, "optional": 0, "bool": true, "long": "--portal-url", "description": "the management portal URL" }, { "flags": "--active-directory-resource-id ", "required": -32, "optional": 0, "bool": true, "long": "--active-directory-resource-id", "description": "The resource ID to obtain AD tokens for" }, { "flags": "--management-endpoint-url ", "required": -27, "optional": 0, "bool": true, "long": "--management-endpoint-url", "description": "the management service endpoint" }, { "flags": "--resource-manager-endpoint-url ", "required": -33, "optional": 0, "bool": true, "long": "--resource-manager-endpoint-url", "description": "the resource management endpoint" }, { "flags": "--sql-management-endpoint-url ", "required": -31, "optional": 0, "bool": true, "long": "--sql-management-endpoint-url", "description": "the sql server management endpoint for mobile commands" }, { "flags": "--sql-server-hostname-suffix ", "required": -30, "optional": 0, "bool": true, "long": "--sql-server-hostname-suffix", "description": "the dns suffix for sql servers" }, { "flags": "--active-directory-endpoint-url ", "required": -33, "optional": 0, "bool": true, "long": "--active-directory-endpoint-url", "description": "the Active Directory login endpoint" }, { "flags": "--azure-data-lake-analytics-catalog-and-job-endpoint-suffix ", "required": -61, "optional": 0, "bool": true, "long": "--azure-data-lake-analytics-catalog-and-job-endpoint-suffix", "description": "the data lake analytics job and catalog service dns suffix" }, { "flags": "--gallery-endpoint-url ", "required": -24, "optional": 0, "bool": true, "long": "--gallery-endpoint-url", "description": "the template gallery endpoint" }, { "flags": "--active-directory-graph-resource-id ", "required": -38, "optional": 0, "bool": true, "long": "--active-directory-graph-resource-id", "description": "the Active Directory resource ID" }, { "flags": "--active-directory-graph-api-version ", "required": -38, "optional": 0, "bool": true, "long": "--active-directory-graph-api-version", "description": "the Active Directory api version" }, { "flags": "--storage-endpoint-suffix ", "required": -27, "optional": 0, "bool": true, "long": "--storage-endpoint-suffix", "description": "the endpoint suffix for storage accounts" }, { "flags": "--key-vault-dns-suffix ", "required": -24, "optional": 0, "bool": true, "long": "--key-vault-dns-suffix", "description": "the keyvault service dns suffix" }, { "flags": "--azure-data-lake-store-file-system-endpoint-suffix ", "required": -53, "optional": 0, "bool": true, "long": "--azure-data-lake-store-file-system-endpoint-suffix", "description": "the data lake store filesystem service dns suffix" }, { "flags": "--publishing-profile-url ", "required": -26, "optional": 0, "bool": true, "long": "--publishing-profile-url", "description": "the publish settings file URL" } ] }, { "name": "delete", "description": "Delete an environment", "fullName": "account env delete", "usage": "[options] [environment]", "filePath": "commands/account.environment.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--environment ", "required": -15, "optional": 0, "bool": true, "long": "--environment", "description": "the environment name" } ] } ], "categories": {} } } }, "batch": { "name": "batch", "description": "Commands to manage your Batch objects", "fullName": "batch", "usage": "[options]", "options": [], "commands": [], "categories": { "account": { "name": "account", "description": "Commands to manage your Batch accounts", "fullName": "batch account", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List the Batch accounts associated with the subscription or resource group", "fullName": "batch account list", "usage": "[options]", "filePath": "commands/batch/batch.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "show", "description": "Show detailed information about the specified Batch account", "fullName": "batch account show", "usage": "[options] ", "filePath": "commands/batch/batch.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "create", "description": "Creates a new Batch account with the specified parameters", "fullName": "batch account create", "usage": "[options] ", "filePath": "commands/batch/batch.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "--tags ", "required": -8, "optional": 0, "bool": true, "long": "--tags", "description": "the account tags. Tags are key=value pairs and separated with semicolon(;)" }, { "flags": "--autostorage-account-id ", "required": -26, "optional": 0, "bool": true, "long": "--autostorage-account-id", "description": "the resource id of the storage account to be used for auto storage" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "set", "description": "Updates the properties of an existing Batch account in the specified resource group", "fullName": "batch account set", "usage": "[options] ", "filePath": "commands/batch/batch.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--tags ", "required": -8, "optional": 0, "bool": true, "long": "--tags", "description": "the account tags. Tags are key=value pairs and separated with semicolon(;)" }, { "flags": "--autostorage-account-id ", "required": -26, "optional": 0, "bool": true, "long": "--autostorage-account-id", "description": "the resource id of the storage account to be used for auto storage" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "delete", "description": "Deletes the specified Batch account", "fullName": "batch account delete", "usage": "[options] ", "filePath": "commands/batch/batch.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for delete confirmation" } ] }, { "name": "sync-autostorage-keys", "description": "Synchronizes access keys for the auto storage account configured for the specified Batch account", "fullName": "batch account sync-autostorage-keys", "usage": "[options] ", "filePath": "commands/batch/batch.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] } ], "categories": { "keys": { "name": "keys", "description": "Commands to manage your Batch account keys", "fullName": "batch account keys", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "Gets the account keys for the given Batch account", "fullName": "batch account keys list", "usage": "[options] ", "filePath": "commands/batch/batch.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "renew", "description": "Regenerates the specified account key for the given Batch account", "fullName": "batch account keys renew", "usage": "[options] ", "filePath": "commands/batch/batch.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--primary", "required": 0, "optional": 0, "bool": true, "long": "--primary", "description": "Update the primary key" }, { "flags": "--secondary", "required": 0, "optional": 0, "bool": true, "long": "--secondary", "description": "Update the secondary key" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] } ], "categories": {} } } }, "application": { "name": "application", "description": "Commands to manage your Batch Application", "fullName": "batch application", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Adds an application to the specified Batch account", "fullName": "batch application create", "usage": "[options] [resource-group] [account-name] [application-id]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "--allow-updates ", "required": -17, "optional": 0, "bool": true, "long": "--allow-updates", "description": "whether packages within the application may be overwritten using the same version string" }, { "flags": "--display-name ", "required": -16, "optional": 0, "bool": true, "long": "--display-name", "description": "the disaply name for the application" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "set", "description": "Updates an application to the specified Batch account", "fullName": "batch application set", "usage": "[options] [resource-group] [account-name] [application-id]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "--allow-updates ", "required": -17, "optional": 0, "bool": true, "long": "--allow-updates", "description": "whether packages within the application may be overwritten using the same version string" }, { "flags": "--display-name ", "required": -16, "optional": 0, "bool": true, "long": "--display-name", "description": "the disaply name for the application" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "delete", "description": "Deletes an application", "fullName": "batch application delete", "usage": "[options] [resource-group] [account-name] [application-id]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "delete the specified application without confirmation" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "show", "description": "Show details of the Batch application", "fullName": "batch application show", "usage": "[options] [resource-group] [account-name] [application-id]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "list", "description": "Lists all of the applications in the specified account", "fullName": "batch application list", "usage": "[options] [resource-group] [account-name]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "list-summary", "description": "Lists all of the applications available in the specified account", "fullName": "batch application list-summary", "usage": "[options]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "show-summary", "description": "Show details of the application in the specified account", "fullName": "batch application show-summary", "usage": "[options] [application-id]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": { "package": { "name": "package", "description": "Commands to manage your Batch Application Package", "fullName": "batch application package", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Creates an application package record", "fullName": "batch application package create", "usage": "[options] [resource-group] [account-name] [application-id] [version] [package-file]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "--version ", "required": -11, "optional": 0, "bool": true, "long": "--version", "description": "the version of the application" }, { "flags": "--package-file ", "required": -16, "optional": 0, "bool": true, "long": "--package-file", "description": "the application package in zip format" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "delete", "description": "Deletes an application package record", "fullName": "batch application package delete", "usage": "[options] [resource-group] [account-name] [application-id] [version]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "--version ", "required": -11, "optional": 0, "bool": true, "long": "--version", "description": "the version of the application to delete" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "delete the specified application package without confirmation" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "show", "description": "Show details of the Batch application package", "fullName": "batch application package show", "usage": "[options] [resource-group] [account-name] [application-id] [version]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "--version ", "required": -11, "optional": 0, "bool": true, "long": "--version", "description": "the version of the application to show" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "activate", "description": "Activate an application package", "fullName": "batch application package activate", "usage": "[options] [resource-group] [account-name] [application-id] [version] [format]", "filePath": "commands/batch/batch.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--account-name ", "required": -16, "optional": 0, "bool": true, "long": "--account-name", "description": "the name of the Batch account" }, { "flags": "--application-id ", "required": -18, "optional": 0, "bool": true, "long": "--application-id", "description": "the id of the application" }, { "flags": "--version ", "required": -11, "optional": 0, "bool": true, "long": "--version", "description": "the version of the application to activate" }, { "flags": "--format ", "required": -10, "optional": 0, "bool": true, "long": "--format", "description": "the format of the application package binary file" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] } ], "categories": {} } } }, "certificate": { "name": "certificate", "description": "Commands to manage your Batch certificate", "fullName": "batch certificate", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Add a certificate", "fullName": "batch certificate create", "usage": "[options] [thumbprint] [cert-file]", "filePath": "commands/batch/batch.certificate.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-t, --thumbprint ", "required": -18, "optional": 0, "bool": true, "short": "-t", "long": "--thumbprint", "description": "the certificate thumbprint" }, { "flags": "-f, --cert-file ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--cert-file", "description": "the certificate file: cer file or pfx file" }, { "flags": "--thumbprint-algorithm ", "required": -24, "optional": 0, "bool": true, "long": "--thumbprint-algorithm", "description": "the certificate thumbprint algorithm" }, { "flags": "-p, --password ", "required": -16, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "the password to access the certificate's private key" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "delete", "description": "Delete the specified Batch certificate", "fullName": "batch certificate delete", "usage": "[options] [thumbprint]", "filePath": "commands/batch/batch.certificate.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-t, --thumbprint ", "required": -18, "optional": 0, "bool": true, "short": "-t", "long": "--thumbprint", "description": "the certificate thumbprint" }, { "flags": "--thumbprint-algorithm ", "required": -24, "optional": 0, "bool": true, "long": "--thumbprint-algorithm", "description": "the certificate thumbprint algorithm" }, { "flags": "--abort", "required": 0, "optional": 0, "bool": true, "long": "--abort", "description": "cancel the deletion" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "delete the specified certificate without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "show", "description": "Show details of the Batch certificate", "fullName": "batch certificate show", "usage": "[options] [thumbprint]", "filePath": "commands/batch/batch.certificate.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-t, --thumbprint ", "required": -18, "optional": 0, "bool": true, "short": "-t", "long": "--thumbprint", "description": "the certificate thumbprint" }, { "flags": "--thumbprint-algorithm ", "required": -24, "optional": 0, "bool": true, "long": "--thumbprint-algorithm", "description": "the certificate thumbprint algorithm" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "list", "description": "List Batch certificates", "fullName": "batch certificate list", "usage": "[options]", "filePath": "commands/batch/batch.certificate.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "task-file": { "name": "task-file", "description": "Commands to manage your Batch task files", "fullName": "batch task-file", "usage": "[options] [command]", "options": [], "commands": [ { "name": "delete", "description": "Deletes the specified task file from the compute node where the task ran", "fullName": "batch task-file delete", "usage": "[options] [job-id] [task-id] [file-name]", "filePath": "commands/batch/batch.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the id of the job that contains the task" }, { "flags": "-i, --task-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--task-id", "description": "the id of the task whose file you want to delete" }, { "flags": "-f, --file-name ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--file-name", "description": "the path to the task file that you want to delete" }, { "flags": "-r, --recursive", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--recursive", "description": "whether to delete children of a directory" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "delete file(s) without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "download", "description": "Download a Batch task file", "fullName": "batch task-file download", "usage": "[options] [job-id] [task-id] [file-name] [destination]", "filePath": "commands/batch/batch.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the batch job id" }, { "flags": "-i, --task-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--task-id", "description": "the batch task id" }, { "flags": "-f, --file-name ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--file-name", "description": "the path to the file that you want to download" }, { "flags": "-d, --destination ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--destination", "description": "path to the destination file or directory" }, { "flags": "--range ", "required": -9, "optional": 0, "bool": true, "long": "--range", "description": "the byte range to be retrieved, the default is to retrieve the entire file" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the destination file without confirmation" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "show", "description": "Gets the properties of the specified task file", "fullName": "batch task-file show", "usage": "[options] [job-id] [task-id] [file-name]", "filePath": "commands/batch/batch.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the id of the job that contains the task" }, { "flags": "-i, --task-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--task-id", "description": "the id of the task whose file you want to get the properties of" }, { "flags": "-f, --file-name ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--file-name", "description": "the path to the file that you want to get the properties of" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "list", "description": "Lists the files in a task's directory on its compute node", "fullName": "batch task-file list", "usage": "[options] [job-id] [task-id]", "filePath": "commands/batch/batch.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the id of the job that contains the task" }, { "flags": "-i, --task-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--task-id", "description": "the id of the task whose files you want to list" }, { "flags": "-r, --recursive", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--recursive", "description": "whether to list children of a directory" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "node-file": { "name": "node-file", "description": "Commands to manage your Batch compute node files", "fullName": "batch node-file", "usage": "[options] [command]", "options": [], "commands": [ { "name": "delete", "description": "Deletes the specified file from the compute node", "fullName": "batch node-file delete", "usage": "[options] [pool-id] [node-id] [file-name]", "filePath": "commands/batch/batch.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node from which you want to delete the file" }, { "flags": "-f, --file-name ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--file-name", "description": "the path to the file that you want to delete" }, { "flags": "-r, --recursive", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--recursive", "description": "whether to delete children of a directory" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "delete file(s) without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "download", "description": "Download a file from a Batch compute node", "fullName": "batch node-file download", "usage": "[options] [pool-id] [node-id] [file-name] [destination]", "filePath": "commands/batch/batch.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node that contains the file" }, { "flags": "-f, --file-name ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--file-name", "description": "the path to the file that you want to download" }, { "flags": "-d, --destination ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--destination", "description": "path to the destination file or directory" }, { "flags": "--range ", "required": -9, "optional": 0, "bool": true, "long": "--range", "description": "the byte range to be retrieved, the default is to retrieve the entire file" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the destination file without confirmation" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "show", "description": "Get the properties of the specified compute node file", "fullName": "batch node-file show", "usage": "[options] [pool-id] [node-id] [file-name]", "filePath": "commands/batch/batch.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node that contains the file" }, { "flags": "-f, --file-name ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--file-name", "description": "the path to the file that you want to get the properties of" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "list", "description": "Lists all of the files in task directories on the specified compute node", "fullName": "batch node-file list", "usage": "[options] [pool-id] [node-id]", "filePath": "commands/batch/batch.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node whose files you want to list" }, { "flags": "-r, --recursive", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--recursive", "description": "whether to list children of a directory" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "job": { "name": "job", "description": "Commands to manage your Batch jobs", "fullName": "batch job", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Adds a job to the specified account", "fullName": "batch job create", "usage": "[options] [json-file]", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-f, --json-file ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--json-file", "description": "the file containing the job object to create in JSON format; if this parameter is specified, all other job parameters are ignored." }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch job id" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of an existing pool; all the tasks of the job will run on the speicfied pool" }, { "flags": "--metadata <--metadata>", "required": -12, "optional": 0, "bool": true, "long": "--metadata", "description": "the semicolon separated list of name-value pairs associated with the job as metadata, ex: name1=value1;name2=value2" }, { "flags": "--priority ", "required": -12, "optional": 0, "bool": true, "long": "--priority", "description": "the priority of the job, ranging from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority; the default value is 0." }, { "flags": "--max-wall-clock-time ", "required": -23, "optional": 0, "bool": true, "long": "--max-wall-clock-time", "description": "the maximum elapsed time that a job may run, in ISO 8601 duration formation" }, { "flags": "--max-task-retry-count ", "required": -24, "optional": 0, "bool": true, "long": "--max-task-retry-count", "description": "the maximum number of times each task may be retried" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "list", "description": "Lists all of the jobs in the specified account", "fullName": "batch job list", "usage": "[options]", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --job-schedule-id [jobScheduleId]", "required": 0, "optional": -23, "bool": true, "short": "-i", "long": "--job-schedule-id", "description": "the id of the job schedule from which you want to get a list of jobs" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "--expand-clause ", "required": -17, "optional": 0, "bool": true, "long": "--expand-clause", "description": "list of related entites by which the results can be expanded" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "show", "description": "Show information about the specified job", "fullName": "batch job show", "usage": "[options] [jobId]", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the id of the job" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--expand-clause ", "required": -17, "optional": 0, "bool": true, "long": "--expand-clause", "description": "list of related entites by which the results can be expanded" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "delete", "description": "Delete the specified job", "fullName": "batch job delete", "usage": "[options] [jobId]", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the id of the job to delete" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified job without confirmation" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "set", "description": "Patch/Update the properties of a job", "fullName": "batch job set", "usage": "[options] [jobId] [json-file]", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the id of the job whose properties you want to patch/update" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of an existing pool; all the tasks of the job will run on the speicfied pool" }, { "flags": "--metadata <--metadata>", "required": -12, "optional": 0, "bool": true, "long": "--metadata", "description": "the semicolon separated list of name-value pairs associated with the job as metadata, ex: name1=value1;name2=value2" }, { "flags": "--priority ", "required": -12, "optional": 0, "bool": true, "long": "--priority", "description": "the priority of the job, ranging from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority; the default value is 0." }, { "flags": "--max-wall-clock-time ", "required": -23, "optional": 0, "bool": true, "long": "--max-wall-clock-time", "description": "the maximum elapsed time that a job may run, in ISO 8601 duration formation" }, { "flags": "--max-task-retry-count ", "required": -24, "optional": 0, "bool": true, "long": "--max-task-retry-count", "description": "the maximum number of times each task may be retried" }, { "flags": "-f, --json-file ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--json-file", "description": "the file containing the job properties to patch/update in JSON format; if this parameter is specified, all other job parameters are ignored." }, { "flags": "-r, --replace", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--replace", "description": "uses update instead of patch" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "enable", "description": "Enables the specified job, allowing new tasks to run", "fullName": "batch job enable", "usage": "[options] ", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "disable", "description": "Disables the specified job. Disabled jobs do not run new tasks, but may be re-enabled later.", "fullName": "batch job disable", "usage": "[options] ", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o, --disable-option ", "required": -22, "optional": 0, "bool": true, "short": "-o", "long": "--disable-option", "description": "specifies what to do with active tasks during a disable job operation, available options include \"requeue\", \"terminate\", and \"wait\"" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "stop", "description": "Terminates the specified job, marking it as completed", "fullName": "batch job stop", "usage": "[options] ", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-r, --reason [reason]", "required": 0, "optional": -14, "bool": true, "short": "-r", "long": "--reason", "description": "the text you want to appear as the job's terminate reason" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": { "prep-release-status": { "name": "prep-release-status", "description": "Commands to manage the status of your job preparation and release tasks", "fullName": "batch job prep-release-status", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "Lists the execution status of the job preparation and job release task for the specified job across the compute nodes where the job has run", "fullName": "batch job prep-release-status list", "usage": "[options] ", "filePath": "commands/batch/batch.job.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} } } }, "job-schedule": { "name": "job-schedule", "description": "Commands to manage your Batch job schedules", "fullName": "batch job-schedule", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Adds a job schedule to the specified account", "fullName": "batch job-schedule create", "usage": "[options] [json-file]", "filePath": "commands/batch/batch.jobSchedule.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-f, --json-file ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--json-file", "description": "the file containing the job schedule object to create in JSON format; if this parameter is specified, all other job schedule parameters are ignored." }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch job schedule id" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of an existing pool; all the tasks of jobs created under this schedule will run on the speicfied pool" }, { "flags": "--priority ", "required": -12, "optional": 0, "bool": true, "long": "--priority", "description": "the priority of the jobs created under this schedule, ranging from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority; the default value is 0." }, { "flags": "--max-wall-clock-time ", "required": -23, "optional": 0, "bool": true, "long": "--max-wall-clock-time", "description": "the maximum elapsed time that a job created under this schedule may run, in ISO 8601 duration formation" }, { "flags": "--max-task-retry-count ", "required": -24, "optional": 0, "bool": true, "long": "--max-task-retry-count", "description": "the maximum number of times each task may be retried" }, { "flags": "--do-not-run-until ", "required": -20, "optional": 0, "bool": true, "long": "--do-not-run-until", "description": "the earliest time at which any ob may be created under this job schedule; if you do not specify a time, the scheudle becomes ready to create jobs immediately." }, { "flags": "--do-not-run-after ", "required": -20, "optional": 0, "bool": true, "long": "--do-not-run-after", "description": "the time after which no job will be created under this job schedule; if you do not specify a time, and you are creating a recurring job schedule, the job schedule will remain active until you explicitly terminate it." }, { "flags": "--start-window ", "required": -16, "optional": 0, "bool": true, "long": "--start-window", "description": "the time interval, starting from the time at which the schedule indicates a job should be created, within which a job must be created, specified in ISO 8601 duration format." }, { "flags": "--recurrence-interval ", "required": -23, "optional": 0, "bool": true, "long": "--recurrence-interval", "description": "the time interval between the start times of two successive jobs under the job schedule, specified in ISO 8601 duration format; the default is that the schedule does not recur." }, { "flags": "--metadata <--metadata>", "required": -12, "optional": 0, "bool": true, "long": "--metadata", "description": "the semicolon separated list of name-value pairs associated with the job schedule as metadata, ex: name1=value1;name2=value2" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "list", "description": "Lists all of the job schedules in the specified account", "fullName": "batch job-schedule list", "usage": "[options]", "filePath": "commands/batch/batch.jobSchedule.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "--expand-clause ", "required": -17, "optional": 0, "bool": true, "long": "--expand-clause", "description": "list of related entites by which the results can be expanded" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "show", "description": "Show information about the specified job schedule", "fullName": "batch job-schedule show", "usage": "[options] [jobScheduleId]", "filePath": "commands/batch/batch.jobSchedule.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the id of the job schedule to get" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--expand-clause ", "required": -17, "optional": 0, "bool": true, "long": "--expand-clause", "description": "list of related entites by which the results can be expanded" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "delete", "description": "Deletes a job schedule from the specified account", "fullName": "batch job-schedule delete", "usage": "[options] [jobScheduleId]", "filePath": "commands/batch/batch.jobSchedule.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the id of the job schedule to delete" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified job schedule without confirmation" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "set", "description": "Patch/Update the properties of the specified job schedule", "fullName": "batch job-schedule set", "usage": "[options] [jobScheduleId] [json-file]", "filePath": "commands/batch/batch.jobSchedule.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the id of the job schedule to patch/update" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of an existing pool; all the tasks of jobs created under this schedule will run on the speicfied pool" }, { "flags": "--priority ", "required": -12, "optional": 0, "bool": true, "long": "--priority", "description": "the priority of the jobs created under this schedule, ranging from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority; the default value is 0." }, { "flags": "--max-wall-clock-time ", "required": -23, "optional": 0, "bool": true, "long": "--max-wall-clock-time", "description": "the maximum elapsed time that a job created under this schedule may run, in ISO 8601 duration formation" }, { "flags": "--max-task-retry-count ", "required": -24, "optional": 0, "bool": true, "long": "--max-task-retry-count", "description": "the maximum number of times each task may be retried" }, { "flags": "--do-not-run-until ", "required": -20, "optional": 0, "bool": true, "long": "--do-not-run-until", "description": "the earliest time at which any ob may be created under this job schedule; if you do not specify a time, the scheudle becomes ready to create jobs immediately." }, { "flags": "--do-not-run-after ", "required": -20, "optional": 0, "bool": true, "long": "--do-not-run-after", "description": "the time after which no job will be created under this job schedule; if you do not specify a time, and you are creating a recurring job schedule, the job schedule will remain active until you explicitly terminate it." }, { "flags": "--start-window ", "required": -16, "optional": 0, "bool": true, "long": "--start-window", "description": "the time interval, starting from the time at which the schedule indicates a job should be created, within which a job must be created, specified in ISO 8601 duration format." }, { "flags": "--recurrence-interval ", "required": -23, "optional": 0, "bool": true, "long": "--recurrence-interval", "description": "the time interval between the start times of two successive jobs under the job schedule, specified in ISO 8601 duration format; the default is that the schedule does not recur." }, { "flags": "-f, --json-file ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--json-file", "description": "the file containing the job schedule properties to patch/update in JSON format; if this parameter is specified, all other job schedule parameters are ignored." }, { "flags": "-r, --replace", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--replace", "description": "uses update instead of patch" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "enable", "description": "Enables the specified job schedule, allowing jobs to be created according to its schedule", "fullName": "batch job-schedule enable", "usage": "[options] ", "filePath": "commands/batch/batch.jobSchedule.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "disable", "description": "Disables the specified job schedule. Disabled schedules do not create new jobs, but may be re-enabled later.", "fullName": "batch job-schedule disable", "usage": "[options] ", "filePath": "commands/batch/batch.jobSchedule.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "stop", "description": "Terminates the specified job schedule", "fullName": "batch job-schedule stop", "usage": "[options] ", "filePath": "commands/batch/batch.jobSchedule.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "node": { "name": "node", "description": "Commands to manage your Batch compute nodes", "fullName": "batch node", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show information about the specified compute node", "fullName": "batch node show", "usage": "[options] [pool-id] [node-id]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node that you want to get information about" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "list", "description": "Lists the compute nodes in the specified pool", "fullName": "batch node list", "usage": "[options] [pool-id]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool from which you want to list nodes" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "reboot", "description": "Restarts the specified compute node", "fullName": "batch node reboot", "usage": "[options] [pool-id] [node-id]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node that you want to restart" }, { "flags": "-o, --reboot-option ", "required": -21, "optional": 0, "bool": true, "short": "-o", "long": "--reboot-option", "description": "when to reboot the compute node and what to do with currently running tasks" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "reboot the specified compute node without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "reimage", "description": "Reinstalls the operating system on the specified compute node", "fullName": "batch node reimage", "usage": "[options] [pool-id] [node-id]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node that you want to reimage" }, { "flags": "-o, --reimage-option ", "required": -22, "optional": 0, "bool": true, "short": "-o", "long": "--reimage-option", "description": "when to reimage the compute node and what to do with currently running tasks" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "reimage the specified compute node without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "delete", "description": "Remove nodes from the Batch pool", "fullName": "batch node delete", "usage": "[options] [pool-id] [node-list]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "-l, --node-list ", "required": -17, "optional": 0, "bool": true, "short": "-l", "long": "--node-list", "description": "the list of node ids" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove nodes from the specified Batch pool without confirmation" }, { "flags": "--resize-timeout ", "required": -18, "optional": 0, "bool": true, "long": "--resize-timeout", "description": "the timeout for removal of compute nodes from the pool, in ISO 8601 duration format" }, { "flags": "-o, --deallocate-option ", "required": -25, "optional": 0, "bool": true, "short": "-o", "long": "--deallocate-option", "description": "sets when nodes may be removed from the pool" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": { "remote-login-settings": { "name": "remote-login-settings", "description": "The remote login settings for a Batch compute node", "fullName": "batch node remote-login-settings", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Gets the remote login settings for the specified node", "fullName": "batch node remote-login-settings show", "usage": "[options] [pool-id] [node-id]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node for which you want to get the remote login settings" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "remote-desktop": { "name": "remote-desktop", "description": "The remote desktop protocol for a Batch compute node", "fullName": "batch node remote-desktop", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Gets the Remote Desktop Protocol file for the specified compute node", "fullName": "batch node remote-desktop show", "usage": "[options] [pool-id] [node-id] [rdp-file]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node for which you want to get the Remote Desktop Protocol file" }, { "flags": "-f, --rdp-file ", "required": -16, "optional": 0, "bool": true, "short": "-f", "long": "--rdp-file", "description": "the path where you would like to save the Remote Desktop Protocol file" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the destination Remote Desktop Protocol file without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "scheduling": { "name": "scheduling", "description": "The scheduling property for a Batch compute node", "fullName": "batch node scheduling", "usage": "[options] [command]", "options": [], "commands": [ { "name": "disable", "description": "Disable scheduling on the Batch compute node", "fullName": "batch node scheduling disable", "usage": "[options] [pool-id] [node-id]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node that you want to disable scheduling" }, { "flags": "-o, --disable-option ", "required": -22, "optional": 0, "bool": true, "short": "-o", "long": "--disable-option", "description": "option of what to do with currently running tasks when to disable scheduling on the compute node" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "enable", "description": "Enable scheduling on the Batch compute node", "fullName": "batch node scheduling enable", "usage": "[options] [pool-id] [node-id]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the compute node that you want to enable scheduling" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} } } }, "node-user": { "name": "node-user", "description": "Commands to manage your Batch compute node users", "fullName": "batch node-user", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Adds a user account to the specified compute node", "fullName": "batch node-user create", "usage": "[options] [pool-id] [node-id] [user-name]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the machine on which you want to create a user account" }, { "flags": "-n, --user-name ", "required": -17, "optional": 0, "bool": true, "short": "-n", "long": "--user-name", "description": "the name of the user account to be created" }, { "flags": "-w, --user-password [user-password]", "required": 0, "optional": -21, "bool": true, "short": "-w", "long": "--user-password", "description": "the password of the user account" }, { "flags": "--ssh-public-key [ssh-public-key]", "required": 0, "optional": -18, "bool": true, "long": "--ssh-public-key", "description": "the ssh public key that can be used for remote login to the compute node; can only be specified for Linux nodes" }, { "flags": "--admin", "required": 0, "optional": 0, "bool": true, "long": "--admin", "description": "whether the account should be an administrator on the compute node" }, { "flags": "--expiry-time [expiry-time]", "required": 0, "optional": -15, "bool": true, "long": "--expiry-time", "description": "the time at which the account should expire" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "delete", "description": "Deletes a user account from the specified compute node", "fullName": "batch node-user delete", "usage": "[options] [pool-id] [node-id] [user-name]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the machine on which you want to delete a user account" }, { "flags": "-n, --user-name ", "required": -17, "optional": 0, "bool": true, "short": "-n", "long": "--user-name", "description": "the name of user account to delete" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified user without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "set", "description": "Update the properties of a user account on the specified compute node", "fullName": "batch node-user set", "usage": "[options] [pool-id] [node-id] [user-name]", "filePath": "commands/batch/batch.node.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --pool-id ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--pool-id", "description": "the id of the pool that contains the compute node" }, { "flags": "-i, --node-id ", "required": -15, "optional": 0, "bool": true, "short": "-i", "long": "--node-id", "description": "the id of the machine on which you want to update a user account" }, { "flags": "-n, --user-name ", "required": -17, "optional": 0, "bool": true, "short": "-n", "long": "--user-name", "description": "the name of the user account to update" }, { "flags": "-w, --user-password [user-password]", "required": 0, "optional": -21, "bool": true, "short": "-w", "long": "--user-password", "description": "the password of the user account" }, { "flags": "--ssh-public-key [ssh-public-key]", "required": 0, "optional": -18, "bool": true, "long": "--ssh-public-key", "description": "the ssh public key that can be used for remote login to the compute node; can only be specified for Linux nodes" }, { "flags": "--expiry-time [expiry-time]", "required": 0, "optional": -15, "bool": true, "long": "--expiry-time", "description": "the time at which the account should expire" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "pool": { "name": "pool", "description": "Commands to manage your Batch pools", "fullName": "batch pool", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a Batch pool", "fullName": "batch pool create", "usage": "[options] [json-file]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-f, --json-file ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--json-file", "description": "the file containing the pool object to create in JSON format, if this parameter is specified, all other pool parameters are ignored" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "-S, --vm-size ", "required": -15, "optional": 0, "bool": true, "short": "-S", "long": "--vm-size", "description": "the size of virtual machines in the pool, ex: small, Standard_D14" }, { "flags": "-t, --target-dedicated ", "required": -24, "optional": 0, "bool": true, "short": "-t", "long": "--target-dedicated", "description": "the desired number of compute nodes in the pool" }, { "flags": "-F, --autoscale-formula ", "required": -25, "optional": 0, "bool": true, "short": "-F", "long": "--autoscale-formula", "description": "the formula for the desired number of compute nodes in the pool, see https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling/ for more detail" }, { "flags": "-o, --os-family ", "required": -17, "optional": 0, "bool": true, "short": "-o", "long": "--os-family", "description": "the Azure Guest OS family to be installed on the virtual machines in the pool, this parameter cannot be used with the --image-publisher, --image-offer, --image-sku and --node-agent-id parameters" }, { "flags": "-p, --image-publisher ", "required": -23, "optional": 0, "bool": true, "short": "-p", "long": "--image-publisher", "description": "the publisher of the Azure Virtual Machines Marketplace image, ex: Canonical or MicrosoftWindowsServer" }, { "flags": "-O, --image-offer ", "required": -19, "optional": 0, "bool": true, "short": "-O", "long": "--image-offer", "description": "the offer type of the Azure Virtual Machines Marketplace image, ex: UbuntuServer or WindowsServer" }, { "flags": "-K, --image-sku ", "required": -17, "optional": 0, "bool": true, "short": "-K", "long": "--image-sku", "description": "the SKU of the Azure Virtual Machines Marketplace image, ex: 14.04.0-LTS or 2012-R2-Datacenter" }, { "flags": "-n, --node-agent-id ", "required": -21, "optional": 0, "bool": true, "short": "-n", "long": "--node-agent-id", "description": "the SKU of Batch Node Agent to be provisioned on the compute node" }, { "flags": "--resize-timeout ", "required": -18, "optional": 0, "bool": true, "long": "--resize-timeout", "description": "the timeout for allocation of compute nodes to the pool, in ISO 8601 duration formation" }, { "flags": "-c, --start-task-cmd ", "required": -22, "optional": 0, "bool": true, "short": "-c", "long": "--start-task-cmd", "description": "the command line of the start task" }, { "flags": "--certificate-ref ", "required": -19, "optional": 0, "bool": true, "long": "--certificate-ref", "description": "the semicolon separated list of thumbprints specifying the certificates to be installed on each compute node in the pool" }, { "flags": "--app-package-ref ", "required": -19, "optional": 0, "bool": true, "long": "--app-package-ref", "description": "the semicolon separated list of ids specifying the application packages to be installed on each compute node in the pool" }, { "flags": "--metadata ", "required": -12, "optional": 0, "bool": true, "long": "--metadata", "description": "the semicolon separated list of name-value pairs associated with the pool as metadata, ex: name1=value1;name2=value" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "list", "description": "List Batch pools", "fullName": "batch pool list", "usage": "[options]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "--expand-clause ", "required": -17, "optional": 0, "bool": true, "long": "--expand-clause", "description": "list of related entites by which the results can be expanded" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "show", "description": "Show information about the specified Batch pool", "fullName": "batch pool show", "usage": "[options] [pool-id]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--expand-clause ", "required": -17, "optional": 0, "bool": true, "long": "--expand-clause", "description": "list of related entites by which the results can be expanded" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "delete", "description": "Delete the specified Batch pool", "fullName": "batch pool delete", "usage": "[options] [pool-id]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified Batch pool without confirmation" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "set", "description": "Patch/Update the properties of the specified Batch pool", "fullName": "batch pool set", "usage": "[options] [pool-id] [json-file]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "-f, --json-file ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--json-file", "description": "the file containing the patch/update pool properties to apply in JSON format, if this parameter is specified, all other pool property parameters are ignored" }, { "flags": "-c, --start-task-cmd ", "required": -22, "optional": 0, "bool": true, "short": "-c", "long": "--start-task-cmd", "description": "the command line of the start task" }, { "flags": "--certificate-ref ", "required": -19, "optional": 0, "bool": true, "long": "--certificate-ref", "description": "the semicolon separated list of thumbprints specifying the certificates to be installed on each compute node in the pool" }, { "flags": "--app-package-ref ", "required": -19, "optional": 0, "bool": true, "long": "--app-package-ref", "description": "the semicolon separated list of ids specifying the application packages to be installed on each compute node in the pool" }, { "flags": "--metadata ", "required": -12, "optional": 0, "bool": true, "long": "--metadata", "description": "the semicolon separated list of name-value pairs associated with the pool as metadata, ex: name1=value1;name2=value" }, { "flags": "-r, --replace", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--replace", "description": "uses update instead of patch" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "resize", "description": "Resize (or stop resizing) the Batch pool", "fullName": "batch pool resize", "usage": "[options] [pool-id] [target-dedicated]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "--abort", "required": 0, "optional": 0, "bool": true, "long": "--abort", "description": "stop resizing" }, { "flags": "-t, --target-dedicated ", "required": -24, "optional": 0, "bool": true, "short": "-t", "long": "--target-dedicated", "description": "the dedicated VM count to resize" }, { "flags": "--resize-timeout ", "required": -18, "optional": 0, "bool": true, "long": "--resize-timeout", "description": "the timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool, in ISO 8601 duration formation" }, { "flags": "-o, --deallocate-option ", "required": -25, "optional": 0, "bool": true, "short": "-o", "long": "--deallocate-option", "description": "sets when nodes may be removed from the pool, if the pool size is decreasing" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": { "autoscale": { "name": "autoscale", "description": "Commands to manage autoscale of your Batch pools", "fullName": "batch pool autoscale", "usage": "[options] [command]", "options": [], "commands": [ { "name": "disable", "description": "Disable autoscale at the Batch pool", "fullName": "batch pool autoscale disable", "usage": "[options] [pool-id]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "enable", "description": "Enable autoscale at the Batch pool", "fullName": "batch pool autoscale enable", "usage": "[options] [pool-id]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "-f, --autoscale-formula ", "required": -25, "optional": 0, "bool": true, "short": "-f", "long": "--autoscale-formula", "description": "the autoscale formula, see https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling/ for more detail" }, { "flags": "--autoscale-evaluation-interval ", "required": -33, "optional": 0, "bool": true, "long": "--autoscale-evaluation-interval", "description": "the time interval for the desired autoscale evaluation period, in ISO 8601 duration formation" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "evaluate", "description": "Evaluate autoscale at the Batch pool", "fullName": "batch pool autoscale evaluate", "usage": "[options] [pool-id] [autoscale-formula]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch pool id" }, { "flags": "-f, --autoscale-formula ", "required": -25, "optional": 0, "bool": true, "short": "-f", "long": "--autoscale-formula", "description": "the autoscale formula, see https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling/ for more detail" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "all-stats": { "name": "all-stats", "description": "Commands to manage all the pools under your Batch account", "fullName": "batch pool all-stats", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show lifetime summary statistics for all of the pools", "fullName": "batch pool all-stats show", "usage": "[options]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "usage-metrics": { "name": "usage-metrics", "description": "Commands to manage usage metrics of your Batch pools", "fullName": "batch pool usage-metrics", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List Batch pool usage metrics", "fullName": "batch pool usage-metrics list", "usage": "[options]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-s, --start-time ", "required": -18, "optional": 0, "bool": true, "short": "-s", "long": "--start-time", "description": "the earliest time from which to include metrics" }, { "flags": "-e, --end-time ", "required": -16, "optional": 0, "bool": true, "short": "-e", "long": "--end-time", "description": "the latest time from which to include metrics" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} }, "node-agent-skus": { "name": "node-agent-skus", "description": "Commands to manage node agent skus of IaaS pools", "fullName": "batch pool node-agent-skus", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "Lists the node agent SKUs supported by the Azure Batch service", "fullName": "batch pool node-agent-skus list", "usage": "[options]", "filePath": "commands/batch/batch.pool.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} } } }, "subscription": { "name": "subscription", "description": "Commands to manage Batch options at the subscription level", "fullName": "batch subscription", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list-quotas", "description": "List the subscription level Batch quotas in the specified region", "fullName": "batch subscription list-quotas", "usage": "[options] ", "filePath": "commands/batch/batch.subscription.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] } ], "categories": {} }, "task": { "name": "task", "description": "Commands to manage your Batch tasks", "fullName": "batch task", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a Batch task", "fullName": "batch task create", "usage": "[options] [jobId] [json-file]", "filePath": "commands/batch/batch.task.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the id of the job to which the task is to be added" }, { "flags": "-f, --json-file ", "required": -17, "optional": 0, "bool": true, "short": "-f", "long": "--json-file", "description": "the file containing either a single task object or an array of task objects in JSON format, if this parameter is specified, --id and --command-line parameters are ignored" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch task id" }, { "flags": "-c, --command-line ", "required": -20, "optional": 0, "bool": true, "short": "-c", "long": "--command-line", "description": "the command line of the task" }, { "flags": "--affinity-id ", "required": -15, "optional": 0, "bool": true, "long": "--affinity-id", "description": "the opaque string representing the location of compute node or a task that has run previously" }, { "flags": "--max-wall-clock-time ", "required": -23, "optional": 0, "bool": true, "long": "--max-wall-clock-time", "description": "the maximum elapsed time that the task may run, measured from the time the task starts, in ISO 8601 duration formation" }, { "flags": "--max-task-retry-count ", "required": -24, "optional": 0, "bool": true, "long": "--max-task-retry-count", "description": "the maximum number of times the task may be retried" }, { "flags": "--retention-time ", "required": -18, "optional": 0, "bool": true, "long": "--retention-time", "description": "the time in which the working directory for the task is retained, in ISO 8601 duration formation" }, { "flags": "-e, --environment-settings ", "required": -28, "optional": 0, "bool": true, "short": "-e", "long": "--environment-settings", "description": "the semicolon separated list of environment variable settings for the task, ex: name1=value1;name2=value2" }, { "flags": "-r, --resources-files ", "required": -23, "optional": 0, "bool": true, "short": "-r", "long": "--resources-files", "description": "the semicolon separated list of files that Batch will download to the compute node before running the command line, ex: blob1=file1;blob2=file2" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "list", "description": "List Batch tasks under a job", "fullName": "batch task list", "usage": "[options] [jobId]", "filePath": "commands/batch/batch.task.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the id of the job from which you want to get a list of tasks" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--filter-clause ", "required": -17, "optional": 0, "bool": true, "long": "--filter-clause", "description": "an OData expression by which the results will be filtered" }, { "flags": "--expand-clause ", "required": -17, "optional": 0, "bool": true, "long": "--expand-clause", "description": "list of related entites by which the results can be expanded" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "show", "description": "Show information on the specified Batch task", "fullName": "batch task show", "usage": "[options] [jobId] [taskId]", "filePath": "commands/batch/batch.task.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the Batch job id" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch task id" }, { "flags": "--subtasks", "required": 0, "optional": 0, "bool": true, "long": "--subtasks", "description": "display information about the subtasks of a multi-instance task" }, { "flags": "--select-clause ", "required": -17, "optional": 0, "bool": true, "long": "--select-clause", "description": "list of a subset of properties to select" }, { "flags": "--expand-clause ", "required": -17, "optional": 0, "bool": true, "long": "--expand-clause", "description": "list of related entites by which the results can be expanded" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "delete", "description": "Delete the specified Batch task", "fullName": "batch task delete", "usage": "[options] [jobId] [taskId]", "filePath": "commands/batch/batch.task.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the Batch job id" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch task id" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified Batch task without confirmation" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "set", "description": "Update the properties of the specified Batch task", "fullName": "batch task set", "usage": "[options] [jobId] [taskId]", "filePath": "commands/batch/batch.task.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the Batch job id" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch task id" }, { "flags": "--max-wall-clock-time ", "required": -23, "optional": 0, "bool": true, "long": "--max-wall-clock-time", "description": "the maximum elapsed time that the task may run, measured from the time the task starts, in ISO 8601 duration formation" }, { "flags": "--max-task-retry-count ", "required": -24, "optional": 0, "bool": true, "long": "--max-task-retry-count", "description": "the maximum number of times the task may be retried" }, { "flags": "--retention-time ", "required": -18, "optional": 0, "bool": true, "long": "--retention-time", "description": "the time in which the working directory for the task is retained, in ISO 8601 duration formation" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] }, { "name": "stop", "description": "Terminate the specified Batch task", "fullName": "batch task stop", "usage": "[options] [jobId] [taskId]", "filePath": "commands/batch/batch.task.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-j, --job-id ", "required": -14, "optional": 0, "bool": true, "short": "-j", "long": "--job-id", "description": "the Batch job id" }, { "flags": "-i, --id ", "required": -10, "optional": 0, "bool": true, "short": "-i", "long": "--id", "description": "the Batch task id" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "terminate the specified Batch task without confirmation" }, { "flags": "--if-match ", "required": -12, "optional": 0, "bool": true, "long": "--if-match", "description": "only perform if resource's ETag is an exact match to the specified value" }, { "flags": "--if-none-match ", "required": -17, "optional": 0, "bool": true, "long": "--if-none-match", "description": "only perform if resource's ETag does not match the specified value" }, { "flags": "--if-modified-since ", "required": -21, "optional": 0, "bool": true, "long": "--if-modified-since", "description": "only perform if the resource has been modified since the specified time" }, { "flags": "--if-unmodified-since ", "required": -23, "optional": 0, "bool": true, "long": "--if-unmodified-since", "description": "only perform if the resource has not been modified since the specified time" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the Batch account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the Batch account key" }, { "flags": "-u, --account-endpoint ", "required": -24, "optional": 0, "bool": true, "short": "-u", "long": "--account-endpoint", "description": "the Batch account URL" } ] } ], "categories": {} } } }, "config": { "name": "config", "description": "Commands to manage your local settings", "fullName": "config", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List config settings", "fullName": "config list", "usage": "[options]", "filePath": "commands/config.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] }, { "name": "delete", "description": "Delete a config setting", "fullName": "config delete", "usage": "[options] ", "filePath": "commands/config.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] }, { "name": "set", "description": "Update a config setting", "fullName": "config set", "usage": " ", "filePath": "commands/config.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] }, { "name": "mode", "description": "Sets the cli working mode, valid names are 'arm' for resource manager and 'asm' for service management", "fullName": "config mode", "usage": "[options] ", "filePath": "commands/config.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] } ], "categories": {} }, "storage": { "name": "storage", "description": "Commands to manage your Storage objects", "fullName": "storage", "usage": "[options]", "options": [], "commands": [], "categories": { "account": { "name": "account", "description": "Commands to manage your Storage accounts", "fullName": "storage account", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List storage accounts", "fullName": "storage account list", "usage": "[options]", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "show", "description": "Show a storage account", "fullName": "storage account show", "usage": "[options] ", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "create", "description": "Create a storage account", "fullName": "storage account create", "usage": "[options] ", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--sku-name ", "required": -12, "optional": 0, "bool": true, "long": "--sku-name", "description": "the SKU name (LRS/ZRS/GRS/RAGRS/PLRS)" }, { "flags": "--kind ", "required": -8, "optional": 0, "bool": true, "long": "--kind", "description": "the account kind (Storage/BlobStorage)" }, { "flags": "--access-tier ", "required": -15, "optional": 0, "bool": true, "long": "--access-tier", "description": "the access tier for Blob storage accounts (Hot/Cool)" }, { "flags": "--enable-encryption-service ", "required": -29, "optional": 0, "bool": true, "long": "--enable-encryption-service", "description": "specifies the service which needs to enable encryption settings" }, { "flags": "--custom-domain ", "required": -17, "optional": 0, "bool": true, "long": "--custom-domain", "description": "the custom domain" }, { "flags": "--subdomain", "required": 0, "optional": 0, "bool": true, "long": "--subdomain", "description": "whether uses the 'asverify' subdomain to preregister the custom domain" }, { "flags": "--tags ", "required": -8, "optional": 0, "bool": true, "long": "--tags", "description": "the account tags. Tags are key=value pairs and separated with semicolon(;)" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "set", "description": "Update a storage account", "fullName": "storage account set", "usage": "[options] ", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--sku-name ", "required": -12, "optional": 0, "bool": true, "long": "--sku-name", "description": "the SKU name (LRS/GRS/RAGRS)" }, { "flags": "--access-tier ", "required": -15, "optional": 0, "bool": true, "long": "--access-tier", "description": "the access tier for Blob storage accounts (Hot/Cool)" }, { "flags": "--enable-encryption-service ", "required": -29, "optional": 0, "bool": true, "long": "--enable-encryption-service", "description": "specifies the service which needs to enable encryption settings" }, { "flags": "--disable-encryption-service ", "required": -30, "optional": 0, "bool": true, "long": "--disable-encryption-service", "description": "specifies the service which needs to disable encryption settings" }, { "flags": "--custom-domain ", "required": -17, "optional": 0, "bool": true, "long": "--custom-domain", "description": "the custom domain" }, { "flags": "--subdomain", "required": 0, "optional": 0, "bool": true, "long": "--subdomain", "description": "whether uses the 'asverify' subdomain to preregister the custom domain" }, { "flags": "--tags ", "required": -8, "optional": 0, "bool": true, "long": "--tags", "description": "the account tags. Tags are key=value pairs and separated with semicolon(;)" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "delete", "description": "Delete a storage account", "fullName": "storage account delete", "usage": "[options] ", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for delete confirmation" } ] }, { "name": "check", "description": "Check whether the account name is valid and is not in use.", "fullName": "storage account check", "usage": "[options] ", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] } ], "categories": { "sas": { "name": "sas", "description": "Commands to manage shared access signatures of your storage account", "fullName": "storage account sas", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate shared access signature of storage account", "fullName": "storage account sas create", "usage": "[options] [services] [resourceTypes] [permissions] [expiry]", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--services ", "required": -12, "optional": 0, "bool": true, "long": "--services", "description": "the storage services accessible with the account SAS combining symbols of b(Blob)/f(File)/q(Queue)/t(Table)" }, { "flags": "--resource-types ", "required": -18, "optional": 0, "bool": true, "long": "--resource-types", "description": "the storage resource types accessible with the account SAS combining symbols of s(Service)/c(Container/o(Object)" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)/a(Add)/c(Create)/u(Update)/p(Process)" }, { "flags": "--protocol ", "required": -12, "optional": 0, "bool": true, "long": "--protocol", "description": "the protocol permitted for a request made with the SAS. Possible values are HttpsOnly and HttpsOrHttp" }, { "flags": "--ip-range ", "required": -12, "optional": 0, "bool": true, "long": "--ip-range", "description": "an IP address or a range of IP addresses from which to accept requests. When specifying a range of IP addresses, note that the range is inclusive. For example, specifying 168.1.5.65 or 168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses." }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the SAS becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the SAS expires" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" } ] } ], "categories": {} }, "keys": { "name": "keys", "description": "Commands to manage your Storage account keys", "fullName": "storage account keys", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List the keys for a storage account", "fullName": "storage account keys list", "usage": "[options] ", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "renew", "description": "Renew a key for a storage account from your account", "fullName": "storage account keys renew", "usage": "[options] ", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--primary", "required": 0, "optional": 0, "bool": true, "long": "--primary", "description": "Update the primary key" }, { "flags": "--secondary", "required": 0, "optional": 0, "bool": true, "long": "--secondary", "description": "Update the secondary key" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] } ], "categories": {} }, "usage": { "name": "usage", "description": "Commands to manage your Storage accounts usage", "fullName": "storage account usage", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show the current count and the limit of the storage accounts under the subscription.", "fullName": "storage account usage show", "usage": "[options] [subscription]", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] } ], "categories": {} }, "connectionstring": { "name": "connectionstring", "description": "Commands to show your Storage connection string", "fullName": "storage account connectionstring", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show the connection string for your account", "fullName": "storage account connectionstring show", "usage": "[options] ", "filePath": "commands/storage/storage.account.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" }, { "flags": "--use-http", "required": 0, "optional": 0, "bool": true, "long": "--use-http", "description": "Use http as default endpoints protocol" }, { "flags": "--blob-endpoint ", "required": -17, "optional": 0, "bool": true, "long": "--blob-endpoint", "description": "the blob endpoint" }, { "flags": "--queue-endpoint ", "required": -18, "optional": 0, "bool": true, "long": "--queue-endpoint", "description": "the queue endpoint" }, { "flags": "--table-endpoint ", "required": -18, "optional": 0, "bool": true, "long": "--table-endpoint", "description": "the table endpoint" }, { "flags": "--file-endpoint ", "required": -17, "optional": 0, "bool": true, "long": "--file-endpoint", "description": "the file endpoint" } ] } ], "categories": {} } } }, "container": { "name": "container", "description": "Commands to manage your storage containers", "fullName": "storage container", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List storage containers with wildcard", "fullName": "storage container list", "usage": "[options] [prefix]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --prefix ", "required": -14, "optional": 0, "bool": true, "short": "-p", "long": "--prefix", "description": "the storage container name prefix" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show details of the specified storage container", "fullName": "storage container show", "usage": "[options] [container]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "create", "description": "Create a storage container", "fullName": "storage container create", "usage": "[options] [container]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-p, --permission ", "required": -18, "optional": 0, "bool": true, "short": "-p", "long": "--permission", "description": "the storage container ACL permission(Off/Blob/Container)" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete the specified storage container", "fullName": "storage container delete", "usage": "[options] [container]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified storage container without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "set", "description": "Set storage container ACL", "fullName": "storage container set", "usage": "[options] [container]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "-p, --permission ", "required": -18, "optional": 0, "bool": true, "short": "-p", "long": "--permission", "description": "the storage container ACL permission(Off/Blob/Container)" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": { "lease": { "name": "lease", "description": "Commands to manage leases of your storage container", "fullName": "storage container lease", "usage": "[options] [command]", "options": [], "commands": [ { "name": "acquire", "description": "Acquire a new lease against your storage container", "fullName": "storage container lease acquire", "usage": "[options] [container] [duration] [proposedId]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--duration ", "required": -12, "optional": 0, "bool": true, "long": "--duration", "description": "the lease duration in seconds (15-60) or not specify for a lease that never expires" }, { "flags": "--proposed-id ", "required": -15, "optional": 0, "bool": true, "long": "--proposed-id", "description": "the proposed lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "renew", "description": "Renew an existing lease against your storage container", "fullName": "storage container lease renew", "usage": "[options] [container] [lease]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the existing lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "change", "description": "Change an existing lease against your storage container", "fullName": "storage container lease change", "usage": "[options] [container] [lease] [proposedId]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the existing lease ID" }, { "flags": "--proposed-id ", "required": -15, "optional": 0, "bool": true, "long": "--proposed-id", "description": "the proposed lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "release", "description": "Release an existing lease against your storage container", "fullName": "storage container lease release", "usage": "[options] [container] [lease]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the existing lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "break", "description": "Break an existing lease against your storage container", "fullName": "storage container lease break", "usage": "[options] [container] [duration]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--duration ", "required": -12, "optional": 0, "bool": true, "long": "--duration", "description": "the proposed duration the lease should continue before it is broken in seconds (0-60)" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "sas": { "name": "sas", "description": "Commands to manage shared access signatures of your storage container", "fullName": "storage container sas", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate shared access signature of storage container", "fullName": "storage container sas create", "usage": "[options] [container] [permissions] [expiry]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)" }, { "flags": "--protocol ", "required": -12, "optional": 0, "bool": true, "long": "--protocol", "description": "the protocol permitted for a request made with the SAS. Possible values are HttpsOnly and HttpsOrHttp" }, { "flags": "--ip-range ", "required": -12, "optional": 0, "bool": true, "long": "--ip-range", "description": "an IP address or a range of IP addresses from which to accept requests. When specifying a range of IP addresses, note that the range is inclusive. For example, specifying 168.1.5.65 or 168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses." }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the SAS becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the SAS expires" }, { "flags": "--policy ", "required": -10, "optional": 0, "bool": true, "long": "--policy", "description": "the stored access policy identifier" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "policy": { "name": "policy", "description": "Commands to manage stored access policies of your storage container", "fullName": "storage container policy", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a stored access policy on the container", "fullName": "storage container policy create", "usage": "[options] [container] [name]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the policy becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the policy expires" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show a stored access policy on the container", "fullName": "storage container policy show", "usage": "[options] [container] [name]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "list", "description": "List stored access policies on the container", "fullName": "storage container policy list", "usage": "[options] [container]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "set", "description": "Set a stored access policy on the container", "fullName": "storage container policy set", "usage": "[options] [container] [name]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the policy expires and passing two spaces means to remove the existing setting" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List) and passing two spaces means to remove the existing setting" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete a stored access policy on the container", "fullName": "storage container policy delete", "usage": "[options] [container] [name]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} } } }, "blob": { "name": "blob", "description": "Commands to manage your storage blobs", "fullName": "storage blob", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List storage blob in the specified storage container use wildcard and blob name prefix", "fullName": "storage blob list", "usage": "[options] [container] [prefix]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-p, --prefix ", "required": -14, "optional": 0, "bool": true, "short": "-p", "long": "--prefix", "description": "the blob name prefix" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show details of the specified storage blob", "fullName": "storage blob show", "usage": "[options] [container] [blob]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete the specified storage blob", "fullName": "storage blob delete", "usage": "[options] [container] [blob]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--snapshot ", "required": -12, "optional": 0, "bool": true, "long": "--snapshot", "description": "the snapshot ID" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "--delete-snapshots ", "required": -20, "optional": 0, "bool": true, "long": "--delete-snapshots", "description": "'include' to delete the base blob and all of its snapshots. 'only' to delete only the blob's snapshots and not the blob itself" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified storage blob without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "upload", "description": "Upload the specified file to storage blob", "fullName": "storage blob upload", "usage": "[options] [file] [container] [blob]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-f, --file ", "required": -12, "optional": 0, "bool": true, "short": "-f", "long": "--file", "description": "the local file path" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "-t, --blobtype ", "required": -16, "optional": 0, "bool": true, "short": "-t", "long": "--blobtype", "description": "the storage blob type(block, page, append)" }, { "flags": "-p, --properties ", "required": -18, "optional": 0, "bool": true, "short": "-p", "long": "--properties", "description": "the storage blob properties for uploaded file. Properties are key=value pairs and separated with semicolon(;). Available properties are contentType, contentEncoding, contentLanguage, cacheControl" }, { "flags": "-m, --metadata ", "required": -16, "optional": 0, "bool": true, "short": "-m", "long": "--metadata", "description": "the storage blob metadata for uploaded file. Metadata are key=value pairs and separated with semicolon(;)" }, { "flags": "--concurrenttaskcount ", "required": -23, "optional": 0, "bool": true, "long": "--concurrenttaskcount", "description": "the maximum number of concurrent upload requests" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the specified storage blob without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "download", "description": "Download the specified storage blob", "fullName": "storage blob download", "usage": "[options] [container] [blob] [destination]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "-d, --destination [destination]", "required": 0, "optional": -19, "bool": true, "short": "-d", "long": "--destination", "description": "download destination file or directory path" }, { "flags": "-m, --checkmd5", "required": 0, "optional": 0, "bool": true, "short": "-m", "long": "--checkmd5", "description": "check md5sum for the downloaded file" }, { "flags": "--concurrenttaskcount ", "required": -23, "optional": 0, "bool": true, "long": "--concurrenttaskcount", "description": "the maximum number of concurrent download requests" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the destination file without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "snapshot", "description": "Creates a read-only snapshot of the blob", "fullName": "storage blob snapshot", "usage": "[options] [container] [blob]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": { "lease": { "name": "lease", "description": "Commands to manage leases of your storage blob", "fullName": "storage blob lease", "usage": "[options] [command]", "options": [], "commands": [ { "name": "acquire", "description": "Acquire a new lease against your storage blob", "fullName": "storage blob lease acquire", "usage": "[options] [container] [blob] [duration] [proposedId]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--duration ", "required": -12, "optional": 0, "bool": true, "long": "--duration", "description": "the lease duration in seconds (15-60) or negative one (-1) for a lease that never expires" }, { "flags": "--proposed-id ", "required": -15, "optional": 0, "bool": true, "long": "--proposed-id", "description": "the proposed lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "renew", "description": "Renew an existing lease against your storage blob", "fullName": "storage blob lease renew", "usage": "[options] [container] [blob] [lease]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the existing lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "change", "description": "Change an existing lease against your storage blob", "fullName": "storage blob lease change", "usage": "[options] [container] [blob] [lease] [proposedId]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the existing lease ID" }, { "flags": "--proposed-id ", "required": -15, "optional": 0, "bool": true, "long": "--proposed-id", "description": "the proposed lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "release", "description": "Release an existing lease against your storage blob", "fullName": "storage blob lease release", "usage": "[options] [container] [blob] [lease]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the existing lease ID" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "break", "description": "Break an existing lease against your storage blob", "fullName": "storage blob lease break", "usage": "[options] [container] [blob] [duration]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "-b, --blob ", "required": -12, "optional": 0, "bool": true, "short": "-b", "long": "--blob", "description": "the storage blob name" }, { "flags": "--duration ", "required": -12, "optional": 0, "bool": true, "long": "--duration", "description": "the proposed duration the lease should continue before it is broken in seconds (0-60)" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "copy": { "name": "copy", "description": "Commands to manage your blob copy operations", "fullName": "storage blob copy", "usage": "[options] [command]", "options": [], "commands": [ { "name": "start", "description": "Start to copy the resource to the specified storage blob which completes asynchronously", "fullName": "storage blob copy start", "usage": "[options] [sourceUri] [destContainer]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--source-sas ", "required": -14, "optional": 0, "bool": true, "long": "--source-sas", "description": "the shared access signature of the source storage" }, { "flags": "--source-uri ", "required": -14, "optional": 0, "bool": true, "long": "--source-uri", "description": "the source storage blob or file absolute uri" }, { "flags": "--source-container ", "required": -20, "optional": 0, "bool": true, "long": "--source-container", "description": "the source storage container name when copies a blob to a blob" }, { "flags": "--source-blob ", "required": -15, "optional": 0, "bool": true, "long": "--source-blob", "description": "the source storage blob name when copies a blob to a blob" }, { "flags": "--snapshot ", "required": -12, "optional": 0, "bool": true, "long": "--snapshot", "description": "the snapshot id if source is a snapshot" }, { "flags": "--source-lease ", "required": -16, "optional": 0, "bool": true, "long": "--source-lease", "description": "the lease ID of the source blob " }, { "flags": "--source-share ", "required": -16, "optional": 0, "bool": true, "long": "--source-share", "description": "the source storage share name when copies a file to a blob" }, { "flags": "--source-path ", "required": -15, "optional": 0, "bool": true, "long": "--source-path", "description": "the source storage file path when copies a file to a blob" }, { "flags": "--dest-account-name ", "required": -21, "optional": 0, "bool": true, "long": "--dest-account-name", "description": "the destination storage account name" }, { "flags": "--dest-account-key ", "required": -20, "optional": 0, "bool": true, "long": "--dest-account-key", "description": "the destination storage account key" }, { "flags": "--dest-connection-string ", "required": -26, "optional": 0, "bool": true, "long": "--dest-connection-string", "description": "the destination storage connection string" }, { "flags": "--dest-sas ", "required": -12, "optional": 0, "bool": true, "long": "--dest-sas", "description": "the shared access signature of the destination storage container or blob" }, { "flags": "--dest-container ", "required": -18, "optional": 0, "bool": true, "long": "--dest-container", "description": "the destination storage container name" }, { "flags": "--dest-blob ", "required": -13, "optional": 0, "bool": true, "long": "--dest-blob", "description": "the destination storage blob name" }, { "flags": "--dest-lease ", "required": -14, "optional": 0, "bool": true, "long": "--dest-lease", "description": "the lease ID of the destination blob " }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the destination blob without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show the copy status", "fullName": "storage blob copy show", "usage": "[options] [container] [blob]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the destination container in the blob copy start operation" }, { "flags": "--blob ", "required": -8, "optional": 0, "bool": true, "long": "--blob", "description": "the destination blob in the blob copy start operation" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID of the destination blob " }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the destination storage container or blob" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "stop", "description": "Stop the copy operation", "fullName": "storage blob copy stop", "usage": "[options] [container] [blob] [copyid]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the destination container in the blob copy start operation" }, { "flags": "--blob ", "required": -8, "optional": 0, "bool": true, "long": "--blob", "description": "the destination blob in the blob copy start operation" }, { "flags": "--lease ", "required": -9, "optional": 0, "bool": true, "long": "--lease", "description": "the lease ID of the destination blob " }, { "flags": "--copyid ", "required": -10, "optional": 0, "bool": true, "long": "--copyid", "description": "the copy ID which is returned from blob copy start operation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "sas": { "name": "sas", "description": "Commands to manage shared access signature of your storage blob", "fullName": "storage blob sas", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate shared access signature of storage blob", "fullName": "storage blob sas create", "usage": "[options] [container] [blob] [permissions] [expiry]", "filePath": "commands/storage/storage.blob.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--container ", "required": -13, "optional": 0, "bool": true, "long": "--container", "description": "the storage container name" }, { "flags": "--blob ", "required": -8, "optional": 0, "bool": true, "long": "--blob", "description": "the storage blob name" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/a(Add)/c(Create)/w(Write)/d(Delete)" }, { "flags": "--protocol ", "required": -12, "optional": 0, "bool": true, "long": "--protocol", "description": "the protocol permitted for a request made with the SAS. Possible values are HttpsOnly and HttpsOrHttp" }, { "flags": "--ip-range ", "required": -12, "optional": 0, "bool": true, "long": "--ip-range", "description": "an IP address or a range of IP addresses from which to accept requests. When specifying a range of IP addresses, note that the range is inclusive. For example, specifying 168.1.5.65 or 168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses." }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the SAS becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the SAS expires" }, { "flags": "--policy ", "required": -10, "optional": 0, "bool": true, "long": "--policy", "description": "the stored access policy identifier" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} } } }, "share": { "name": "share", "description": "Commands to manage your Storage file shares", "fullName": "storage share", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a storage file share", "fullName": "storage share create", "usage": "[options] [share]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage file share name" }, { "flags": "--quota ", "required": -9, "optional": 0, "bool": true, "long": "--quota", "description": "the storage file share quota (in GB)" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show details of the storage file share", "fullName": "storage share show", "usage": "[options] [share]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage file share name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "set", "description": "Set properties of the storage file share", "fullName": "storage share set", "usage": "[options] [share]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage file share name" }, { "flags": "--quota ", "required": -9, "optional": 0, "bool": true, "long": "--quota", "description": "the storage file share quota (in GB)" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete the specified storage file share", "fullName": "storage share delete", "usage": "[options] [share]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage file share name" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified storage file share without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "list", "description": "List storage shares with prefix", "fullName": "storage share list", "usage": "[options] [prefix]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --prefix ", "required": -14, "optional": 0, "bool": true, "short": "-p", "long": "--prefix", "description": "the storage share name prefix" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": { "sas": { "name": "sas", "description": "Commands to manage shared access signatures of your Storage file shares", "fullName": "storage share sas", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate shared access signature of storage share", "fullName": "storage share sas create", "usage": "[options] [share] [permissions] [expiry]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)" }, { "flags": "--protocol ", "required": -12, "optional": 0, "bool": true, "long": "--protocol", "description": "the protocol permitted for a request made with the SAS. Possible values are HttpsOnly and HttpsOrHttp" }, { "flags": "--ip-range ", "required": -12, "optional": 0, "bool": true, "long": "--ip-range", "description": "an IP address or a range of IP addresses from which to accept requests. When specifying a range of IP addresses, note that the range is inclusive. For example, specifying 168.1.5.65 or 168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses." }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the SAS becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the SAS expires" }, { "flags": "--policy ", "required": -10, "optional": 0, "bool": true, "long": "--policy", "description": "the stored access policy identifier" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "policy": { "name": "policy", "description": "Commands to manage stored access policies of your Storage file share", "fullName": "storage share policy", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a stored access policy on the share", "fullName": "storage share policy create", "usage": "[options] [share] [name]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the policy becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the policy expires" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List)" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show a stored access policy on the share", "fullName": "storage share policy show", "usage": "[options] [share] [name]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "list", "description": "List stored access policies on the share", "fullName": "storage share policy list", "usage": "[options] [share]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "set", "description": "Set a stored access policy on the share", "fullName": "storage share policy set", "usage": "[options] [share] [name]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the policy expires and passing two spaces means to remove the existing setting" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)/l(List) and passing two spaces means to remove the existing setting" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete a stored access policy on the share", "fullName": "storage share policy delete", "usage": "[options] [share] [name]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} } } }, "file": { "name": "file", "description": "Commands to manage your Storage files", "fullName": "storage file", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List storage files in the specified share under specific path", "fullName": "storage file list", "usage": "[options] [share] [path]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "-p, --path ", "required": -12, "optional": 0, "bool": true, "short": "-p", "long": "--path", "description": "the path to be listed" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the storage file share" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete the specified storage file", "fullName": "storage file delete", "usage": "[options] [share] [path]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "-p, --path ", "required": -12, "optional": 0, "bool": true, "short": "-p", "long": "--path", "description": "the path to the storage file" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified storage file without confirmation" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the storage file share" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "upload", "description": "Upload the specified local file to storage", "fullName": "storage file upload", "usage": "[options] [source] [share] [path]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-s, --source ", "required": -14, "optional": 0, "bool": true, "short": "-s", "long": "--source", "description": "the local file path" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "-p, --path ", "required": -12, "optional": 0, "bool": true, "short": "-p", "long": "--path", "description": "the path to the storage file" }, { "flags": "--concurrenttaskcount ", "required": -23, "optional": 0, "bool": true, "long": "--concurrenttaskcount", "description": "the maximum number of concurrent upload requests" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the specified storage file without confirmation" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the storage file share" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "download", "description": "Download the specified storage file", "fullName": "storage file download", "usage": "[options] [share] [path] [destination]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "-p, --path ", "required": -12, "optional": 0, "bool": true, "short": "-p", "long": "--path", "description": "the path to the storage file" }, { "flags": "-d, --destination ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--destination", "description": "path to the destination file or directory" }, { "flags": "-m, --checkmd5", "required": 0, "optional": 0, "bool": true, "short": "-m", "long": "--checkmd5", "description": "check md5sum for the downloaded file" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the destination file without confirmation" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the storage file share" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": { "copy": { "name": "copy", "description": "Commands to manage your file copy operations", "fullName": "storage file copy", "usage": "[options] [command]", "options": [], "commands": [ { "name": "start", "description": "Start to copy the resource to the specified storage file which completes asynchronously", "fullName": "storage file copy start", "usage": "[options] [sourceUri] [destShare]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--source-sas ", "required": -14, "optional": 0, "bool": true, "long": "--source-sas", "description": "the shared access signature of the source storage" }, { "flags": "--source-uri ", "required": -14, "optional": 0, "bool": true, "long": "--source-uri", "description": "the source storage blob or file absolute uri" }, { "flags": "--source-share ", "required": -16, "optional": 0, "bool": true, "long": "--source-share", "description": "the source storage share name when copies a file to a blob" }, { "flags": "--source-path ", "required": -15, "optional": 0, "bool": true, "long": "--source-path", "description": "the source storage file path when copies a file to a blob" }, { "flags": "--source-container ", "required": -20, "optional": 0, "bool": true, "long": "--source-container", "description": "the source storage container name when copies a blob to a blob" }, { "flags": "--source-blob ", "required": -15, "optional": 0, "bool": true, "long": "--source-blob", "description": "the source storage blob name when copies a blob to a blob" }, { "flags": "--dest-account-name ", "required": -21, "optional": 0, "bool": true, "long": "--dest-account-name", "description": "the destination storage account name" }, { "flags": "--dest-account-key ", "required": -20, "optional": 0, "bool": true, "long": "--dest-account-key", "description": "the destination storage account key" }, { "flags": "--dest-connection-string ", "required": -26, "optional": 0, "bool": true, "long": "--dest-connection-string", "description": "the destination storage connection string" }, { "flags": "--dest-sas ", "required": -12, "optional": 0, "bool": true, "long": "--dest-sas", "description": "the shared access signature of the destination storage share or file" }, { "flags": "--dest-share ", "required": -14, "optional": 0, "bool": true, "long": "--dest-share", "description": "the destination storage share name" }, { "flags": "--dest-path ", "required": -13, "optional": 0, "bool": true, "long": "--dest-path", "description": "the destination storage file path" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "overwrite the destination file without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show the copy status", "fullName": "storage file copy show", "usage": "[options] [share] [path]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the destination share in the file copy start operation" }, { "flags": "--path ", "required": -8, "optional": 0, "bool": true, "long": "--path", "description": "the destination file path in the file copy start operation" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the destination storage share or file" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "stop", "description": "Stop the copy operation", "fullName": "storage file copy stop", "usage": "[options] [share] [path] [copyid]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the destination share in the file copy start operation" }, { "flags": "--path ", "required": -8, "optional": 0, "bool": true, "long": "--path", "description": "the destination file path in the file copy start operation" }, { "flags": "--copyid ", "required": -10, "optional": 0, "bool": true, "long": "--copyid", "description": "the copy ID which is returned from file copy start operation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "sas": { "name": "sas", "description": "Commands to manage shared access signatures of your Storage file", "fullName": "storage file sas", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate shared access signature of storage file", "fullName": "storage file sas create", "usage": "[options] [share] [path] [permissions] [expiry]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "-p, --path ", "required": -12, "optional": 0, "bool": true, "short": "-p", "long": "--path", "description": "the path to the storage file" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/w(Write)/d(Delete)" }, { "flags": "--protocol ", "required": -12, "optional": 0, "bool": true, "long": "--protocol", "description": "the protocol permitted for a request made with the SAS. Possible values are HttpsOnly and HttpsOrHttp" }, { "flags": "--ip-range ", "required": -12, "optional": 0, "bool": true, "long": "--ip-range", "description": "an IP address or a range of IP addresses from which to accept requests. When specifying a range of IP addresses, note that the range is inclusive. For example, specifying 168.1.5.65 or 168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses." }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the SAS becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the SAS expires" }, { "flags": "--policy ", "required": -10, "optional": 0, "bool": true, "long": "--policy", "description": "the stored access policy identifier" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} } } }, "directory": { "name": "directory", "description": "Commands to manage your Storage file directory", "fullName": "storage directory", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a storage file directory", "fullName": "storage directory create", "usage": "[options] [share] [path]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage file share name" }, { "flags": "-p, --path ", "required": -12, "optional": 0, "bool": true, "short": "-p", "long": "--path", "description": "the path to the storage file directory to be created" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the storage file share" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete the specified storage file directory", "fullName": "storage directory delete", "usage": "[options] [share] [path]", "filePath": "commands/storage/storage.file.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--share ", "required": -9, "optional": 0, "bool": true, "long": "--share", "description": "the storage share name" }, { "flags": "-p, --path ", "required": -12, "optional": 0, "bool": true, "short": "-p", "long": "--path", "description": "the path to the storage file directory to be deleted" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified storage file directory without confirmation" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the storage file share" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "queue": { "name": "queue", "description": "Commands to manage your Storage queues", "fullName": "storage queue", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a storage queue", "fullName": "storage queue create", "usage": "[options] [queue]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "list", "description": "List storage queues with wildcard", "fullName": "storage queue list", "usage": "[options] [prefix]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --prefix ", "required": -14, "optional": 0, "bool": true, "short": "-p", "long": "--prefix", "description": "the storage queue name prefix" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show details of the storage able", "fullName": "storage queue show", "usage": "[options] [queue]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "--sas ", "required": -7, "optional": 0, "bool": true, "long": "--sas", "description": "the shared access signature of the storage queue" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete the specified storage queue", "fullName": "storage queue delete", "usage": "[options] [queue]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified storage queue without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": { "sas": { "name": "sas", "description": "Commands to manage shared access signatures of your Storage queue", "fullName": "storage queue sas", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate shared access signature of storage queue", "fullName": "storage queue sas create", "usage": "[options] [queue] [permissions] [expiry]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/a(Add)/u(Update)/p(Process)" }, { "flags": "--protocol ", "required": -12, "optional": 0, "bool": true, "long": "--protocol", "description": "the protocol permitted for a request made with the SAS. Possible values are HttpsOnly and HttpsOrHttp" }, { "flags": "--ip-range ", "required": -12, "optional": 0, "bool": true, "long": "--ip-range", "description": "an IP address or a range of IP addresses from which to accept requests. When specifying a range of IP addresses, note that the range is inclusive. For example, specifying 168.1.5.65 or 168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses." }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the SAS becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the SAS expires" }, { "flags": "--policy ", "required": -10, "optional": 0, "bool": true, "long": "--policy", "description": "the stored access policy identifier" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "policy": { "name": "policy", "description": "Commands to manage stored access policies of your Storage queue", "fullName": "storage queue policy", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a stored access policy on the queue", "fullName": "storage queue policy create", "usage": "[options] [queue] [name]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the policy becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the policy expires" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/a(Add)/u(Update)/p(Process)" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show a stored access policy on the queue", "fullName": "storage queue policy show", "usage": "[options] [queue] [name]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "list", "description": "List stored access policies on the queue", "fullName": "storage queue policy list", "usage": "[options] [queue]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "set", "description": "Set a stored access policy on the queue", "fullName": "storage queue policy set", "usage": "[options] [queue] [name]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the policy expires and passing two spaces means to remove the existing setting" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Read)/a(Add)/u(Update)/p(Process) and passing two spaces means to remove the existing setting" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete a stored access policy on the queue", "fullName": "storage queue policy delete", "usage": "[options] [queue] [name]", "filePath": "commands/storage/storage.queue.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--queue ", "required": -9, "optional": 0, "bool": true, "long": "--queue", "description": "the storage queue name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} } } }, "logging": { "name": "logging", "description": "Commands to manage your Storage logging properties", "fullName": "storage logging", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show the logging properties of the storage services ", "fullName": "storage logging show", "usage": "[options]", "filePath": "commands/storage/storage.service.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--blob", "required": 0, "optional": 0, "bool": true, "long": "--blob", "description": "show logging properties for blob service" }, { "flags": "--table", "required": 0, "optional": 0, "bool": true, "long": "--table", "description": "show logging properties for table service" }, { "flags": "--queue", "required": 0, "optional": 0, "bool": true, "long": "--queue", "description": "show logging properties for queue service" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "set", "description": "Set the logging properties of the storage service", "fullName": "storage logging set", "usage": "[options]", "filePath": "commands/storage/storage.service.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--blob", "required": 0, "optional": 0, "bool": true, "long": "--blob", "description": "set logging properties for blob service" }, { "flags": "--table", "required": 0, "optional": 0, "bool": true, "long": "--table", "description": "set logging properties for table service" }, { "flags": "--queue", "required": 0, "optional": 0, "bool": true, "long": "--queue", "description": "set logging properties for queue service" }, { "flags": "--version ", "required": -11, "optional": 0, "bool": true, "long": "--version", "description": "the version string" }, { "flags": "--retention ", "required": -13, "optional": 0, "bool": true, "long": "--retention", "description": "set logging retention in days" }, { "flags": "--read", "required": 0, "optional": 0, "bool": true, "long": "--read", "description": "enable logging for read requests" }, { "flags": "--read-off", "required": 0, "optional": 0, "bool": true, "long": "--read-off", "description": "disable logging for read requests" }, { "flags": "--write", "required": 0, "optional": 0, "bool": true, "long": "--write", "description": "enable logging for write requests" }, { "flags": "--write-off", "required": 0, "optional": 0, "bool": true, "long": "--write-off", "description": "disable logging for write requests" }, { "flags": "--delete", "required": 0, "optional": 0, "bool": true, "long": "--delete", "description": "enable logging for delete requests" }, { "flags": "--delete-off", "required": 0, "optional": 0, "bool": true, "long": "--delete-off", "description": "disable logging for delete requests" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "metrics": { "name": "metrics", "description": "Commands to manage your Storage metrics properties", "fullName": "storage metrics", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show the metrics properties of the storage services ", "fullName": "storage metrics show", "usage": "[options]", "filePath": "commands/storage/storage.service.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--blob", "required": 0, "optional": 0, "bool": true, "long": "--blob", "description": "show metrics properties for blob service" }, { "flags": "--table", "required": 0, "optional": 0, "bool": true, "long": "--table", "description": "show metrics properties for table service" }, { "flags": "--queue", "required": 0, "optional": 0, "bool": true, "long": "--queue", "description": "show metrics properties for queue service" }, { "flags": "--file", "required": 0, "optional": 0, "bool": true, "long": "--file", "description": "show metrics properties for file service" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "set", "description": "Set the metrics properties of the storage service", "fullName": "storage metrics set", "usage": "[options]", "filePath": "commands/storage/storage.service.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--blob", "required": 0, "optional": 0, "bool": true, "long": "--blob", "description": "set metrics properties for blob service" }, { "flags": "--table", "required": 0, "optional": 0, "bool": true, "long": "--table", "description": "set metrics properties for table service" }, { "flags": "--queue", "required": 0, "optional": 0, "bool": true, "long": "--queue", "description": "set metrics properties for queue service" }, { "flags": "--file", "required": 0, "optional": 0, "bool": true, "long": "--file", "description": "set metrics properties for file service" }, { "flags": "--version ", "required": -11, "optional": 0, "bool": true, "long": "--version", "description": "the version string" }, { "flags": "--retention ", "required": -13, "optional": 0, "bool": true, "long": "--retention", "description": "set metrics retention in days" }, { "flags": "--hour", "required": 0, "optional": 0, "bool": true, "long": "--hour", "description": "set hourly metrics properties" }, { "flags": "--hour-off", "required": 0, "optional": 0, "bool": true, "long": "--hour-off", "description": "turn off hourly metrics properties" }, { "flags": "--minute", "required": 0, "optional": 0, "bool": true, "long": "--minute", "description": "set minute metrics properties" }, { "flags": "--minute-off", "required": 0, "optional": 0, "bool": true, "long": "--minute-off", "description": "turn off minute metrics properties" }, { "flags": "--api", "required": 0, "optional": 0, "bool": true, "long": "--api", "description": "include API in metrics " }, { "flags": "--api-off", "required": 0, "optional": 0, "bool": true, "long": "--api-off", "description": "exclude API from metrics" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "cors": { "name": "cors", "description": "Commands to manage your Storage CORS (Cross-Origin Resource Sharing)", "fullName": "storage cors", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set the CORS rules of the storage service", "fullName": "storage cors set", "usage": "[options]", "filePath": "commands/storage/storage.service.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--blob", "required": 0, "optional": 0, "bool": true, "long": "--blob", "description": "set CORS rules for blob service" }, { "flags": "--table", "required": 0, "optional": 0, "bool": true, "long": "--table", "description": "set CORS rules for table service" }, { "flags": "--queue", "required": 0, "optional": 0, "bool": true, "long": "--queue", "description": "set CORS rules for queue service" }, { "flags": "--file", "required": 0, "optional": 0, "bool": true, "long": "--file", "description": "set CORS rules for file service" }, { "flags": "--cors ", "required": -8, "optional": 0, "bool": true, "long": "--cors", "description": "the CORS rules array in json format" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show the CORS rules of the storage service", "fullName": "storage cors show", "usage": "[options]", "filePath": "commands/storage/storage.service.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--blob", "required": 0, "optional": 0, "bool": true, "long": "--blob", "description": "show CORS rules for blob service" }, { "flags": "--table", "required": 0, "optional": 0, "bool": true, "long": "--table", "description": "show CORS rules for table service" }, { "flags": "--queue", "required": 0, "optional": 0, "bool": true, "long": "--queue", "description": "show CORS rules for queue service" }, { "flags": "--file", "required": 0, "optional": 0, "bool": true, "long": "--file", "description": "show CORS rules for file service" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete all the CORS rules of the storage service", "fullName": "storage cors delete", "usage": "[options]", "filePath": "commands/storage/storage.service.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--blob", "required": 0, "optional": 0, "bool": true, "long": "--blob", "description": "delete CORS rules for blob service" }, { "flags": "--table", "required": 0, "optional": 0, "bool": true, "long": "--table", "description": "delete CORS rules for table service" }, { "flags": "--queue", "required": 0, "optional": 0, "bool": true, "long": "--queue", "description": "delete CORS rules for queue service" }, { "flags": "--file", "required": 0, "optional": 0, "bool": true, "long": "--file", "description": "delete CORS rules for file service" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "delete the CORS rules without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "table": { "name": "table", "description": "Commands to manage your Storage tables", "fullName": "storage table", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a storage table", "fullName": "storage table create", "usage": "[options] [table]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table ", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "list", "description": "List storage tables with wildcard", "fullName": "storage table list", "usage": "[options] [prefix]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-p, --prefix ", "required": -14, "optional": 0, "bool": true, "short": "-p", "long": "--prefix", "description": "the storage table name prefix" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show details of the storage able", "fullName": "storage table show", "usage": "[options] [table]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table
", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete the specified storage table", "fullName": "storage table delete", "usage": "[options] [table]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table
", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "remove the specified storage table without confirmation" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": { "sas": { "name": "sas", "description": "Commands to manage shared access signatures of your Storage table", "fullName": "storage table sas", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate a shared access signature of storage table", "fullName": "storage table sas create", "usage": "[options] [table] [permissions] [expiry]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table
", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Query)/a(Add)/u(Update)/d(Delete)" }, { "flags": "--protocol ", "required": -12, "optional": 0, "bool": true, "long": "--protocol", "description": "the protocol permitted for a request made with the SAS. Possible values are HttpsOnly and HttpsOrHttp" }, { "flags": "--ip-range ", "required": -12, "optional": 0, "bool": true, "long": "--ip-range", "description": "an IP address or a range of IP addresses from which to accept requests. When specifying a range of IP addresses, note that the range is inclusive. For example, specifying 168.1.5.65 or 168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses." }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the SAS becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the SAS expires" }, { "flags": "--policy ", "required": -10, "optional": 0, "bool": true, "long": "--policy", "description": "the stored access policy identifier" }, { "flags": "--start-pk ", "required": -12, "optional": 0, "bool": true, "long": "--start-pk", "description": "the inclusive starting partition key" }, { "flags": "--end-pk ", "required": -10, "optional": 0, "bool": true, "long": "--end-pk", "description": "the inclusive ending partition key" }, { "flags": "--start-rk ", "required": -12, "optional": 0, "bool": true, "long": "--start-rk", "description": "the inclusive starting row key" }, { "flags": "--end-rk ", "required": -10, "optional": 0, "bool": true, "long": "--end-rk", "description": "the inclusive ending row key" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} }, "policy": { "name": "policy", "description": "Commands to manage stored access policies of your Storage table", "fullName": "storage table policy", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a stored access policy on the table", "fullName": "storage table policy create", "usage": "[options] [table] [name]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table
", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the policy becomes valid" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the policy expires" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Query)/a(Add)/u(Update)/d(Delete)" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "show", "description": "Show a stored access policy on the table", "fullName": "storage table policy show", "usage": "[options] [table] [name]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table
", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "list", "description": "List stored access policies on the table", "fullName": "storage table policy list", "usage": "[options] [table]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table
", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "set", "description": "Set a stored access policy on the table", "fullName": "storage table policy set", "usage": "[options] [table] [name]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table
", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "--start ", "required": -9, "optional": 0, "bool": true, "long": "--start", "description": "the UTC time at which the policy becomes valid and passing two spaces means to remove the existing setting" }, { "flags": "--expiry ", "required": -10, "optional": 0, "bool": true, "long": "--expiry", "description": "the UTC time at which the policy expires and passing two spaces means to remove the existing setting" }, { "flags": "--permissions ", "required": -15, "optional": 0, "bool": true, "long": "--permissions", "description": "the operation permissions combining symbols of r(Query)/a(Add)/u(Update)/d(Delete) and passing two spaces means to remove the existing setting" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "delete", "description": "Delete a stored access policy on the table", "fullName": "storage table policy delete", "usage": "[options] [table] [name]", "filePath": "commands/storage/storage.table.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--table
", "required": -9, "optional": 0, "bool": true, "long": "--table", "description": "the storage table name" }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "the policy name" }, { "flags": "-a, --account-name ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--account-name", "description": "the storage account name" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] } ], "categories": {} } } } } }, "acs": { "name": "acs", "description": "Commands to manage your container service. ", "fullName": "acs", "usage": "[options] [command]", "options": [], "commands": [ { "name": "scale", "description": "The operation to scale a container service.", "fullName": "acs scale", "usage": "[options] ", "filePath": "commands/arm/acs/acs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-o, --new-agent-count ", "required": -23, "optional": 0, "bool": true, "short": "-o", "long": "--new-agent-count", "description": "New agent count" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "create", "description": "The operation to create or update a container service.", "fullName": "acs create", "usage": "[options] ", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-p, --parameters ", "required": -18, "optional": 0, "bool": true, "short": "-p", "long": "--parameters", "description": "A string of parameters in JSON format" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The text file that contains input parameter object in JSON format" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "delete", "description": "The operation to delete a container service.", "fullName": "acs delete", "usage": "[options] ", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "show", "description": "The operation to get a container service.", "fullName": "acs show", "usage": "[options] ", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "list", "description": "The operation to list container services.", "fullName": "acs list", "usage": "[options] ", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] } ], "categories": { "config": { "name": "config", "description": "Commands to manage configuration of container-service in the parameter file.", "fullName": "acs config", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate containerServiceCreateOrUpdate parameter string or files.", "fullName": "acs config create", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." } ] }, { "name": "patch", "description": "Command to patch containerServiceCreateOrUpdate parameter JSON file.", "fullName": "acs config patch", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--operation ", "required": -13, "optional": 0, "bool": true, "long": "--operation", "description": "The JSON patch operation: add, remove, or replace." }, { "flags": "--path ", "required": -8, "optional": 0, "bool": true, "long": "--path", "description": "The JSON data path, e.g.: \"foo/1\"." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The JSON value." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the JSON value to object." } ] } ], "categories": { "container-service": { "name": "container-service", "description": "Commands to configure container-service of acs in config file.", "fullName": "acs config container-service", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set container-service in config string or files, e.g. \r\n{\r\n \"provisioningState\":\"\",\r\n \"orchestratorProfile\":{\r\n \"orchestratorType\":null\r\n },\r\n \"masterProfile\":{\r\n \"count\":null,\r\n \"dnsPrefix\":\"\",\r\n \"fqdn\":\"\"\r\n },\r\n \"agentPoolProfiles\":[\r\n {\r\n \"name\":\"\",\r\n \"count\":null,\r\n \"vmSize\":\"\",\r\n \"dnsPrefix\":\"\",\r\n \"fqdn\":\"\"\r\n }\r\n ],\r\n \"windowsProfile\":{\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\"\r\n },\r\n \"linuxProfile\":{\r\n \"adminUsername\":\"\",\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"diagnosticsProfile\":{\r\n \"vmDiagnostics\":{\r\n \"enabled\":null,\r\n \"storageUri\":\"\"\r\n }\r\n },\r\n \"id\":null,\r\n \"name\":null,\r\n \"type\":null,\r\n \"location\":\"\",\r\n \"tags\":{\r\n }\r\n}\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config container-service set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--provisioning-state ", "required": -22, "optional": 0, "bool": true, "long": "--provisioning-state", "description": "Set the provisioning-state value." }, { "flags": "--orchestrator-profile ", "required": -24, "optional": 0, "bool": true, "long": "--orchestrator-profile", "description": "Set the orchestrator-profile value." }, { "flags": "--master-profile ", "required": -18, "optional": 0, "bool": true, "long": "--master-profile", "description": "Set the master-profile value." }, { "flags": "--agent-pool-profiles ", "required": -23, "optional": 0, "bool": true, "long": "--agent-pool-profiles", "description": "Set the agent-pool-profiles value." }, { "flags": "--windows-profile ", "required": -19, "optional": 0, "bool": true, "long": "--windows-profile", "description": "Set the windows-profile value." }, { "flags": "--linux-profile ", "required": -17, "optional": 0, "bool": true, "long": "--linux-profile", "description": "Set the linux-profile value." }, { "flags": "--diagnostics-profile ", "required": -23, "optional": 0, "bool": true, "long": "--diagnostics-profile", "description": "Set the diagnostics-profile value." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "Set the name value." }, { "flags": "--type ", "required": -8, "optional": 0, "bool": true, "long": "--type", "description": "Set the type value." }, { "flags": "--location ", "required": -12, "optional": 0, "bool": true, "long": "--location", "description": "Set the location value." }, { "flags": "--tags ", "required": -8, "optional": 0, "bool": true, "long": "--tags", "description": "Set the tags value." } ] }, { "name": "delete", "description": "Remove container-service in config string or files, e.g. \r\n{\r\n \"provisioningState\":\"\",\r\n \"orchestratorProfile\":{\r\n \"orchestratorType\":null\r\n },\r\n \"masterProfile\":{\r\n \"count\":null,\r\n \"dnsPrefix\":\"\",\r\n \"fqdn\":\"\"\r\n },\r\n \"agentPoolProfiles\":[\r\n {\r\n \"name\":\"\",\r\n \"count\":null,\r\n \"vmSize\":\"\",\r\n \"dnsPrefix\":\"\",\r\n \"fqdn\":\"\"\r\n }\r\n ],\r\n \"windowsProfile\":{\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\"\r\n },\r\n \"linuxProfile\":{\r\n \"adminUsername\":\"\",\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"diagnosticsProfile\":{\r\n \"vmDiagnostics\":{\r\n \"enabled\":null,\r\n \"storageUri\":\"\"\r\n }\r\n },\r\n \"id\":null,\r\n \"name\":null,\r\n \"type\":null,\r\n \"location\":\"\",\r\n \"tags\":{\r\n }\r\n}\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config container-service delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--provisioning-state", "required": 0, "optional": 0, "bool": true, "long": "--provisioning-state", "description": "Remove the provisioning-state value." }, { "flags": "--orchestrator-profile", "required": 0, "optional": 0, "bool": true, "long": "--orchestrator-profile", "description": "Remove the orchestrator-profile value." }, { "flags": "--master-profile", "required": 0, "optional": 0, "bool": true, "long": "--master-profile", "description": "Remove the master-profile value." }, { "flags": "--agent-pool-profiles", "required": 0, "optional": 0, "bool": true, "long": "--agent-pool-profiles", "description": "Remove the agent-pool-profiles value." }, { "flags": "--windows-profile", "required": 0, "optional": 0, "bool": true, "long": "--windows-profile", "description": "Remove the windows-profile value." }, { "flags": "--linux-profile", "required": 0, "optional": 0, "bool": true, "long": "--linux-profile", "description": "Remove the linux-profile value." }, { "flags": "--diagnostics-profile", "required": 0, "optional": 0, "bool": true, "long": "--diagnostics-profile", "description": "Remove the diagnostics-profile value." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." }, { "flags": "--name", "required": 0, "optional": 0, "bool": true, "long": "--name", "description": "Remove the name value." }, { "flags": "--type", "required": 0, "optional": 0, "bool": true, "long": "--type", "description": "Remove the type value." }, { "flags": "--location", "required": 0, "optional": 0, "bool": true, "long": "--location", "description": "Remove the location value." }, { "flags": "--tags", "required": 0, "optional": 0, "bool": true, "long": "--tags", "description": "Remove the tags value." } ] } ], "categories": {} }, "orchestrator-profile": { "name": "orchestrator-profile", "description": "Commands to configure orchestrator-profile of acs in config file.", "fullName": "acs config orchestrator-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set orchestrator-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"orchestratorProfile\" : {\r\n \"orchestratorType\":null\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config orchestrator-profile set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--orchestrator-type ", "required": -21, "optional": 0, "bool": true, "long": "--orchestrator-type", "description": "Set the orchestrator-type value." } ] }, { "name": "delete", "description": "Remove orchestrator-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"orchestratorProfile\" : {\r\n \"orchestratorType\":null\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config orchestrator-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--orchestrator-type", "required": 0, "optional": 0, "bool": true, "long": "--orchestrator-type", "description": "Remove the orchestrator-type value." } ] } ], "categories": {} }, "master-profile": { "name": "master-profile", "description": "Commands to configure master-profile of acs in config file.", "fullName": "acs config master-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set master-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"masterProfile\" : {\r\n \"count\":null,\r\n \"dnsPrefix\":\"\",\r\n \"fqdn\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config master-profile set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--count ", "required": -9, "optional": 0, "bool": true, "long": "--count", "description": "Set the count value." }, { "flags": "--dns-prefix ", "required": -14, "optional": 0, "bool": true, "long": "--dns-prefix", "description": "Set the dns-prefix value." }, { "flags": "--fqdn ", "required": -8, "optional": 0, "bool": true, "long": "--fqdn", "description": "Set the fqdn value." } ] }, { "name": "delete", "description": "Remove master-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"masterProfile\" : {\r\n \"count\":null,\r\n \"dnsPrefix\":\"\",\r\n \"fqdn\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config master-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--count", "required": 0, "optional": 0, "bool": true, "long": "--count", "description": "Remove the count value." }, { "flags": "--dns-prefix", "required": 0, "optional": 0, "bool": true, "long": "--dns-prefix", "description": "Remove the dns-prefix value." }, { "flags": "--fqdn", "required": 0, "optional": 0, "bool": true, "long": "--fqdn", "description": "Remove the fqdn value." } ] } ], "categories": {} }, "agent-pool-profiles": { "name": "agent-pool-profiles", "description": "Commands to configure agent-pool-profiles of acs in config file.", "fullName": "acs config agent-pool-profiles", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set agent-pool-profiles in config string or files, e.g. \r\n {\r\n ...\r\n \"agentPoolProfiles\" : {\r\n \"name\":\"\",\r\n \"count\":null,\r\n \"vmSize\":\"\",\r\n \"dnsPrefix\":\"\",\r\n \"fqdn\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config agent-pool-profiles set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "Set the name value." }, { "flags": "--count ", "required": -9, "optional": 0, "bool": true, "long": "--count", "description": "Set the count value." }, { "flags": "--vm-size ", "required": -11, "optional": 0, "bool": true, "long": "--vm-size", "description": "Set the vm-size value." }, { "flags": "--dns-prefix ", "required": -14, "optional": 0, "bool": true, "long": "--dns-prefix", "description": "Set the dns-prefix value." }, { "flags": "--fqdn ", "required": -8, "optional": 0, "bool": true, "long": "--fqdn", "description": "Set the fqdn value." } ] }, { "name": "delete", "description": "Remove agent-pool-profiles in config string or files, e.g. \r\n {\r\n ...\r\n \"agentPoolProfiles\" : {\r\n \"name\":\"\",\r\n \"count\":null,\r\n \"vmSize\":\"\",\r\n \"dnsPrefix\":\"\",\r\n \"fqdn\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config agent-pool-profiles delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--name", "required": 0, "optional": 0, "bool": true, "long": "--name", "description": "Remove the name value." }, { "flags": "--count", "required": 0, "optional": 0, "bool": true, "long": "--count", "description": "Remove the count value." }, { "flags": "--vm-size", "required": 0, "optional": 0, "bool": true, "long": "--vm-size", "description": "Remove the vm-size value." }, { "flags": "--dns-prefix", "required": 0, "optional": 0, "bool": true, "long": "--dns-prefix", "description": "Remove the dns-prefix value." }, { "flags": "--fqdn", "required": 0, "optional": 0, "bool": true, "long": "--fqdn", "description": "Remove the fqdn value." } ] } ], "categories": {} }, "windows-profile": { "name": "windows-profile", "description": "Commands to configure windows-profile of acs in config file.", "fullName": "acs config windows-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set windows-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"windowsProfile\" : {\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config windows-profile set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--admin-username ", "required": -18, "optional": 0, "bool": true, "long": "--admin-username", "description": "Set the admin-username value." }, { "flags": "--admin-password ", "required": -18, "optional": 0, "bool": true, "long": "--admin-password", "description": "Set the admin-password value." } ] }, { "name": "delete", "description": "Remove windows-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"windowsProfile\" : {\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config windows-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--admin-username", "required": 0, "optional": 0, "bool": true, "long": "--admin-username", "description": "Remove the admin-username value." }, { "flags": "--admin-password", "required": 0, "optional": 0, "bool": true, "long": "--admin-password", "description": "Remove the admin-password value." } ] } ], "categories": {} }, "linux-profile": { "name": "linux-profile", "description": "Commands to configure linux-profile of acs in config file.", "fullName": "acs config linux-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set linux-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"linuxProfile\" : {\r\n \"adminUsername\":\"\",\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config linux-profile set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--admin-username ", "required": -18, "optional": 0, "bool": true, "long": "--admin-username", "description": "Set the admin-username value." }, { "flags": "--ssh ", "required": -7, "optional": 0, "bool": true, "long": "--ssh", "description": "Set the ssh value." } ] }, { "name": "delete", "description": "Remove linux-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"linuxProfile\" : {\r\n \"adminUsername\":\"\",\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config linux-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--admin-username", "required": 0, "optional": 0, "bool": true, "long": "--admin-username", "description": "Remove the admin-username value." }, { "flags": "--ssh", "required": 0, "optional": 0, "bool": true, "long": "--ssh", "description": "Remove the ssh value." } ] } ], "categories": {} }, "ssh": { "name": "ssh", "description": "Commands to configure ssh of acs in config file.", "fullName": "acs config ssh", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set ssh in config string or files, e.g. \r\n {\r\n ...\r\n \"ssh\" : {\r\n \"publicKeys\":[\r\n {\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config ssh set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--public-keys ", "required": -15, "optional": 0, "bool": true, "long": "--public-keys", "description": "Set the public-keys value." } ] }, { "name": "delete", "description": "Remove ssh in config string or files, e.g. \r\n {\r\n ...\r\n \"ssh\" : {\r\n \"publicKeys\":[\r\n {\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config ssh delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--public-keys", "required": 0, "optional": 0, "bool": true, "long": "--public-keys", "description": "Remove the public-keys value." } ] } ], "categories": {} }, "public-keys": { "name": "public-keys", "description": "Commands to configure public-keys of acs in config file.", "fullName": "acs config public-keys", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set public-keys in config string or files, e.g. \r\n {\r\n ...\r\n \"publicKeys\" : {\r\n \"keyData\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config public-keys set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--key-data ", "required": -12, "optional": 0, "bool": true, "long": "--key-data", "description": "Set the key-data value." } ] }, { "name": "delete", "description": "Remove public-keys in config string or files, e.g. \r\n {\r\n ...\r\n \"publicKeys\" : {\r\n \"keyData\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config public-keys delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--key-data", "required": 0, "optional": 0, "bool": true, "long": "--key-data", "description": "Remove the key-data value." } ] } ], "categories": {} }, "diagnostics-profile": { "name": "diagnostics-profile", "description": "Commands to configure diagnostics-profile of acs in config file.", "fullName": "acs config diagnostics-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set diagnostics-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"diagnosticsProfile\" : {\r\n \"vmDiagnostics\":{\r\n \"enabled\":null,\r\n \"storageUri\":\"\"\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config diagnostics-profile set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--vm-diagnostics ", "required": -18, "optional": 0, "bool": true, "long": "--vm-diagnostics", "description": "Set the vm-diagnostics value." } ] }, { "name": "delete", "description": "Remove diagnostics-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"diagnosticsProfile\" : {\r\n \"vmDiagnostics\":{\r\n \"enabled\":null,\r\n \"storageUri\":\"\"\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config diagnostics-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--vm-diagnostics", "required": 0, "optional": 0, "bool": true, "long": "--vm-diagnostics", "description": "Remove the vm-diagnostics value." } ] } ], "categories": {} }, "vm-diagnostics": { "name": "vm-diagnostics", "description": "Commands to configure vm-diagnostics of acs in config file.", "fullName": "acs config vm-diagnostics", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set vm-diagnostics in config string or files, e.g. \r\n {\r\n ...\r\n \"vmDiagnostics\" : {\r\n \"enabled\":null,\r\n \"storageUri\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config vm-diagnostics set", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--enabled ", "required": -11, "optional": 0, "bool": true, "long": "--enabled", "description": "Set the enabled value." }, { "flags": "--storage-uri ", "required": -15, "optional": 0, "bool": true, "long": "--storage-uri", "description": "Set the storage-uri value." } ] }, { "name": "delete", "description": "Remove vm-diagnostics in config string or files, e.g. \r\n {\r\n ...\r\n \"vmDiagnostics\" : {\r\n \"enabled\":null,\r\n \"storageUri\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "acs config vm-diagnostics delete", "usage": "[options]", "filePath": "commands/arm/compute/containerService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--enabled", "required": 0, "optional": 0, "bool": true, "long": "--enabled", "description": "Remove the enabled value." }, { "flags": "--storage-uri", "required": 0, "optional": 0, "bool": true, "long": "--storage-uri", "description": "Remove the storage-uri value." } ] } ], "categories": {} } } } } }, "ad": { "name": "ad", "description": "Commands to display Active Directory objects", "fullName": "ad", "usage": "[options]", "options": [], "commands": [], "categories": { "app": { "name": "app", "description": "Commands to display Active Directory applications", "fullName": "ad app", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Creates a new Active Directory application", "fullName": "ad app create", "usage": "[options] ", "filePath": "commands/arm/ad/ad.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n --name ", "required": -11, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the display name for the application" }, { "flags": "-m --home-page ", "required": -16, "optional": 0, "bool": true, "short": "-m", "long": "--home-page", "description": "the URL to the application homepage" }, { "flags": "-a --available", "required": 0, "optional": 0, "bool": true, "short": "-a", "long": "--available", "description": "indicates if the application will be available to other tenants" }, { "flags": "-p --password ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "the value for the password credential associated with the application that will be valid for one year by default" }, { "flags": "-i --identifier-uris ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--identifier-uris", "description": "the comma-delimitied URIs that identify the application" }, { "flags": "-r --reply-urls ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--reply-urls", "description": "the comma-delimitied application reply urls" }, { "flags": "--key-value ", "required": -13, "optional": 0, "bool": true, "long": "--key-value", "description": "the value for the key credentials associated with the application that will be valid for one year by default" }, { "flags": "--key-type ", "required": -12, "optional": 0, "bool": true, "long": "--key-type", "description": "the type of the key credentials associated with the application. Acceptable values are AsymmetricX509Cert, Password and Symmetric" }, { "flags": "--key-usage ", "required": -13, "optional": 0, "bool": true, "long": "--key-usage", "description": "the usage of the key credentials associated with the application. Acceptable values are Sign and Verify" }, { "flags": "--start-date ", "required": -14, "optional": 0, "bool": true, "long": "--start-date", "description": "the start date after which password or key would be valid. Default value is current time" }, { "flags": "--end-date ", "required": -12, "optional": 0, "bool": true, "long": "--end-date", "description": "the end date till which password or key is valid. Default value is one year after current time" } ] }, { "name": "set", "description": "Updates the properties of the created Active Directory application", "fullName": "ad app set", "usage": "[options]", "filePath": "commands/arm/ad/ad.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object id of the application to update. Either provide objectId or applicationId. objectId is more preferable." }, { "flags": "-a --applicationId ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--applicationId", "description": "the applicationId of the application to update. If you have created a service principal using this application then this will be the spn of the service principal." }, { "flags": "-n --name ", "required": -11, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the new display name for the application." }, { "flags": "-m --home-page ", "required": -16, "optional": 0, "bool": true, "short": "-m", "long": "--home-page", "description": "the new URL to the application homepage" }, { "flags": "-p --password ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "new value for the password credential associated with the application that will be valid for one year by default" }, { "flags": "-i --identifier-uris ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--identifier-uris", "description": "new comma-delimitied URI values that identify the application" }, { "flags": "-r --reply-urls ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--reply-urls", "description": "new comma-delimitied application reply urls" }, { "flags": "--key-value ", "required": -13, "optional": 0, "bool": true, "long": "--key-value", "description": "new value for the key credentials associated with the application that will be valid for one year by default" }, { "flags": "--key-type ", "required": -12, "optional": 0, "bool": true, "long": "--key-type", "description": "new type of the key credentials associated with the application. Acceptable values are AsymmetricX509Cert, Password and Symmetric. Default value: AsymmetricX509Cert" }, { "flags": "--key-usage ", "required": -13, "optional": 0, "bool": true, "long": "--key-usage", "description": "new usage of the key credentials associated with the application. Acceptable values are Sign and Verify. Default value: Verify" }, { "flags": "--start-date ", "required": -14, "optional": 0, "bool": true, "long": "--start-date", "description": "new start date value after which password or key would be valid. Default value is current time" }, { "flags": "--end-date ", "required": -12, "optional": 0, "bool": true, "long": "--end-date", "description": "new end date value till which password or key is valid. Default value is one year after current time" } ] }, { "name": "delete", "description": "Deletes the Active Directory application", "fullName": "ad app delete", "usage": "[options] ", "filePath": "commands/arm/ad/ad.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object id of the application to remove" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode (do not ask for delete confirmation)" } ] }, { "name": "list", "description": "Get all Active Directory applications in current subscription's tenant", "fullName": "ad app list", "usage": "[options]", "filePath": "commands/arm/ad/ad.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" } ] }, { "name": "show", "description": "Get Active Directory applications", "fullName": "ad app show", "usage": "[options]", "filePath": "commands/arm/ad/ad.application.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-a --applicationId ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--applicationId", "description": "the name of the application to return" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object id of the application to return" }, { "flags": "-i --identifierUri ", "required": -20, "optional": 0, "bool": true, "short": "-i", "long": "--identifierUri", "description": "the identifier uri of the application to return" }, { "flags": "-c --search ", "required": -13, "optional": 0, "bool": true, "short": "-c", "long": "--search", "description": "search display name of the application starting with the provided value" } ] } ], "categories": {} }, "group": { "name": "group", "description": "Commands to display Active Directory groups", "fullName": "ad group", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "Get Active Directory groups in current subscription's tenant", "fullName": "ad group list", "usage": "[options]", "filePath": "commands/arm/ad/ad.groups.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "| more", "required": 0, "optional": 0, "bool": true, "short": "", "long": "more", "description": "Provides paging support. Press 'Enter' for more information." } ] }, { "name": "show", "description": "Get Active Directory groups", "fullName": "ad group show", "usage": "[options]", "filePath": "commands/arm/ad/ad.groups.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object Id of the group to return" }, { "flags": "-c --search ", "required": -13, "optional": 0, "bool": true, "short": "-c", "long": "--search", "description": "Search by display name which starts with the provided value" } ] }, { "name": "create", "description": "Creates an Active Directory group in the tenant.", "fullName": "ad group create", "usage": "[options] ", "filePath": "commands/arm/ad/ad.groups.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-d --display-name ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--display-name", "description": "The name to display in the address book for the group." }, { "flags": "-m --mail-nickname ", "required": -20, "optional": 0, "bool": true, "short": "-m", "long": "--mail-nickname", "description": "The mail alias for the group." } ] }, { "name": "delete", "description": "Deletes an Active Directory group.", "fullName": "ad group delete", "usage": "[options] ", "filePath": "commands/arm/ad/ad.groups.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object Id of the group to delete" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode (do not ask for delete confirmation)" } ] } ], "categories": { "member": { "name": "member", "description": "Commands to provide an Active Directory sub group or member info", "fullName": "ad group member", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "Provides an Active Directory sub group or member info", "fullName": "ad group member list", "usage": "[options] ", "filePath": "commands/arm/ad/ad.groups.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "Object id of group whose members to return." } ] }, { "name": "add", "description": "Adds a member to an Active Directory group.", "fullName": "ad group member add", "usage": "[options] ", "filePath": "commands/arm/ad/ad.groups.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "Object id of group to which the member needs to be added." }, { "flags": "-m --member-objectId ", "required": -22, "optional": 0, "bool": true, "short": "-m", "long": "--member-objectId", "description": "Object id of the member (application, user, servicePrincipal, another-group) to be added to this group." }, { "flags": "-e --graph-endpoint ", "required": -21, "optional": 0, "bool": true, "short": "-e", "long": "--graph-endpoint", "description": "The graph endpoint which will be the part of the member url created by the command. Default value: 'https://graph.windows.net'." }, { "flags": "-t --tenant ", "required": -13, "optional": 0, "bool": true, "short": "-t", "long": "--tenant", "description": "TenantId (in a GUID format) to which the member belongs. Default value is the current tenant of the logged in user/sp." } ] }, { "name": "delete", "description": "Deletes a member from an Active Directory group.", "fullName": "ad group member delete", "usage": "[options] ", "filePath": "commands/arm/ad/ad.groups.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "Object id of group from which the member needs to be deleted." }, { "flags": "-m --member-objectId ", "required": -22, "optional": 0, "bool": true, "short": "-m", "long": "--member-objectId", "description": "Object id of the member (application, user, servicePrincipal, another-group) to be deleted from this group." }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode (do not ask for delete confirmation)" } ] }, { "name": "check", "description": "Checks whether the specified user, group, contact, or service principal is a direct or a transitive member of the specified Active Directory group.", "fullName": "ad group member check", "usage": "[options] ", "filePath": "commands/arm/ad/ad.groups.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "Object id of group against which the membership needs to be checked." }, { "flags": "-m --member-objectId ", "required": -22, "optional": 0, "bool": true, "short": "-m", "long": "--member-objectId", "description": "Object id of the member (application, user, servicePrincipal, another-group) for which membership needs to be checked in the specified group." } ] } ], "categories": {} } } }, "sp": { "name": "sp", "description": "Commands to display Active Directory service principals", "fullName": "ad sp", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "Get all Active Directory service principals in current subscription's tenant", "fullName": "ad sp list", "usage": "[options]", "filePath": "commands/arm/ad/ad.servicePrincipals.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "| more", "required": 0, "optional": 0, "bool": true, "short": "", "long": "more", "description": "Provides paging support. Press 'Enter' for more information." } ] }, { "name": "show", "description": "Get Active Directory service principals", "fullName": "ad sp show", "usage": "[options]", "filePath": "commands/arm/ad/ad.servicePrincipals.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n --spn ", "required": -10, "optional": 0, "bool": true, "short": "-n", "long": "--spn", "description": "the name of the service principal to return" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object id of the service principal to return" }, { "flags": "-c --search ", "required": -13, "optional": 0, "bool": true, "short": "-c", "long": "--search", "description": "search display name of the service principal starting with the provided value" } ] }, { "name": "create", "description": "Create Active Directory service principal.", "fullName": "ad sp create", "usage": "[options]", "filePath": "commands/arm/ad/ad.servicePrincipals.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-a --applicationId ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--applicationId", "description": "The application Id for which service principal needs to be created. If this is provided then everything else will be ignored. \nWhen the applicationId is provided it means that the application was already created and it needs to be used to create the service principal." }, { "flags": "-n --name ", "required": -11, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the display name for the application" }, { "flags": "-m --home-page ", "required": -16, "optional": 0, "bool": true, "short": "-m", "long": "--home-page", "description": "the URL to the application homepage" }, { "flags": "-b --available", "required": 0, "optional": 0, "bool": true, "short": "-b", "long": "--available", "description": "indicates if the application will be available to other tenants" }, { "flags": "-p --password ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "the value for the password credential associated with the application that will be valid for one year by default" }, { "flags": "-i --identifier-uris ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--identifier-uris", "description": "the comma-delimitied URIs that identify the application" }, { "flags": "-r --reply-urls ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--reply-urls", "description": "the comma-delimitied application reply urls" }, { "flags": "--key-value ", "required": -13, "optional": 0, "bool": true, "long": "--key-value", "description": "the value for the key credentials associated with the application that will be valid for one year by default" }, { "flags": "--key-type ", "required": -12, "optional": 0, "bool": true, "long": "--key-type", "description": "the type of the key credentials associated with the application. Acceptable values are AsymmetricX509Cert, Password and Symmetric" }, { "flags": "--key-usage ", "required": -13, "optional": 0, "bool": true, "long": "--key-usage", "description": "the usage of the key credentials associated with the application. Acceptable values are Sign and Verify" }, { "flags": "--start-date ", "required": -14, "optional": 0, "bool": true, "long": "--start-date", "description": "the start date after which password or key would be valid. Default value is current time" }, { "flags": "--end-date ", "required": -12, "optional": 0, "bool": true, "long": "--end-date", "description": "the end date till which password or key is valid. Default value is one year after current time" } ] }, { "name": "set", "description": "Updates the properties of the created Active Directory ServicePrincipal", "fullName": "ad sp set", "usage": "[options] ", "filePath": "commands/arm/ad/ad.servicePrincipals.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object id of the servicePrincipal to update." }, { "flags": "-n --name ", "required": -11, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the new display name for the application." }, { "flags": "-m --home-page ", "required": -16, "optional": 0, "bool": true, "short": "-m", "long": "--home-page", "description": "the new URL to the application homepage" }, { "flags": "-p --password ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "new value for the password credential associated with the application that will be valid for one year by default" }, { "flags": "-i --identifier-uris ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--identifier-uris", "description": "new comma-delimitied URI values that identify the application" }, { "flags": "-r --reply-urls ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--reply-urls", "description": "new comma-delimitied application reply urls" }, { "flags": "--key-value ", "required": -13, "optional": 0, "bool": true, "long": "--key-value", "description": "new value for the key credentials associated with the application that will be valid for one year by default" }, { "flags": "--key-type ", "required": -12, "optional": 0, "bool": true, "long": "--key-type", "description": "new type of the key credentials associated with the application. Acceptable values are AsymmetricX509Cert, Password and Symmetric. Default value: AsymmetricX509Cert" }, { "flags": "--key-usage ", "required": -13, "optional": 0, "bool": true, "long": "--key-usage", "description": "new usage of the key credentials associated with the application. Acceptable values are Sign and Verify. Default value: Verify" }, { "flags": "--start-date ", "required": -14, "optional": 0, "bool": true, "long": "--start-date", "description": "new start date value after which password or key would be valid. Default value is current time" }, { "flags": "--end-date ", "required": -12, "optional": 0, "bool": true, "long": "--end-date", "description": "new end date value till which password or key is valid. Default value is one year after current time" } ] }, { "name": "delete", "description": "Deletes Active Directory service principal.", "fullName": "ad sp delete", "usage": "[options] ", "filePath": "commands/arm/ad/ad.servicePrincipals.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object id of the service principal to delete" }, { "flags": "-p --preserve-application", "required": 0, "optional": 0, "bool": true, "short": "-p", "long": "--preserve-application", "description": "Default value: false. If you do not want to delete the underlying application then set this flag." }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode (do not ask for delete confirmation)" } ] } ], "categories": {} }, "user": { "name": "user", "description": "Commands to display Active Directory users", "fullName": "ad user", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "Get all Active Directory users in current subscription's tenant", "fullName": "ad user list", "usage": "[options]", "filePath": "commands/arm/ad/ad.users.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "| more", "required": 0, "optional": 0, "bool": true, "short": "", "long": "more", "description": "Provides paging support. Press 'Enter' for more information." } ] }, { "name": "show", "description": "Get an Active Directory user", "fullName": "ad user show", "usage": "[options]", "filePath": "commands/arm/ad/ad.users.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-u --upn ", "required": -10, "optional": 0, "bool": true, "short": "-u", "long": "--upn", "description": "the principal name of the user to return" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the object id of the user to return" }, { "flags": "-c --search ", "required": -13, "optional": 0, "bool": true, "short": "-c", "long": "--search", "description": "search users with display name starting with the provided value" } ] }, { "name": "delete", "description": "Deletes Active Directory user (work/school account also popularly known as org-id).", "fullName": "ad user delete", "usage": "[options] ", "filePath": "commands/arm/ad/ad.users.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-u --upn-or-objectId ", "required": -22, "optional": 0, "bool": true, "short": "-u", "long": "--upn-or-objectId", "description": "the user principal name or the objectId." }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode (do not ask for delete confirmation)." } ] }, { "name": "create", "description": "Create Active Directory user (work/school account also popularly known as org-id). For more information: https://msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#CreateUser", "fullName": "ad user create", "usage": "[options] ", "filePath": "commands/arm/ad/ad.users.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-u --upn ", "required": -10, "optional": 0, "bool": true, "short": "-u", "long": "--upn", "description": "the user principal name. example - 'someuser@contoso.com'." }, { "flags": "-i --immutableId ", "required": -18, "optional": 0, "bool": true, "short": "-i", "long": "--immutableId", "description": "It needs to be specified only if you are using a federated domain for the user's user principal name (upn) property." }, { "flags": "-d --display-name ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--display-name", "description": "the name to display in the address book for the user. example 'Alex Wu'" }, { "flags": "-m --mail-nickname ", "required": -20, "optional": 0, "bool": true, "short": "-m", "long": "--mail-nickname", "description": "the mail alias for the user. example: 'Alexw'." }, { "flags": "-p --password ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "password for the user. It must meet the tenant's password complexity requirements. It is recommended to set a strong password." }, { "flags": "-f --force-change-password-next-login", "required": 0, "optional": 0, "bool": true, "short": "-f", "long": "--force-change-password-next-login", "description": "It must be specified if the user must change the password on the next successful login (true). Default behavior is (false) to not change the password on the next successful login." } ] }, { "name": "set", "description": "Update an existing Active Directory user (work/school account also popularly known as org-id). For more information: https://msdn.microsoft.com/en-us/library/azure/ad/graph/api/users-operations#UpdateUser", "fullName": "ad user set", "usage": "[options] ", "filePath": "commands/arm/ad/ad.users.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-u --upn-or-objectId ", "required": -22, "optional": 0, "bool": true, "short": "-u", "long": "--upn-or-objectId", "description": "the user principal name ('someuser@contoso.com') or the objectId (a Guid) for which the properties need to be updated." }, { "flags": "-a --enable-account ", "required": -21, "optional": 0, "bool": true, "short": "-a", "long": "--enable-account", "description": "true for enabling the account; otherwise, false." }, { "flags": "-d --display-name ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--display-name", "description": "new name to display in the address book for the user. example 'Alex Wu'" }, { "flags": "-m --mail-nickname ", "required": -20, "optional": 0, "bool": true, "short": "-m", "long": "--mail-nickname", "description": "new mail alias for the user. example: 'Alexw'." }, { "flags": "-p --password ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "new password for the user. It must meet the tenant's password complexity requirements. It is recommended to set a strong password." }, { "flags": "-f --force-change-password-next-login", "required": 0, "optional": 0, "bool": true, "short": "-f", "long": "--force-change-password-next-login", "description": "It must be specified only when you are updating the password. Otherwise it will be ignored. It must be specified if the user must change the password on the next successful login (true). Default behavior is (false) to not change the password on the next successful login." } ] } ], "categories": { "memberGroups": { "name": "memberGroups", "description": "Commands to display member groups of the Active Directory user.", "fullName": "ad user memberGroups", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "Provides a lit of Object IDs of the groups of which the user is a member.", "fullName": "ad user memberGroups list", "usage": "[options] ", "filePath": "commands/arm/ad/ad.users.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-o --objectId ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--objectId", "description": "the objectId of the user" }, { "flags": "-e --securityEnabledOnly", "required": 0, "optional": 0, "bool": true, "short": "-e", "long": "--securityEnabledOnly", "description": "If true, only membership in security enabled groups will be checked. Otherwise membership in all groups will be checked. Default: false" } ] } ], "categories": {} } } } } }, "availset": { "name": "availset", "description": "Commands to manage your availability sets. ", "fullName": "availset", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Creates an availability set within a resource group", "fullName": "availset create", "usage": "[options] [tags]", "filePath": "commands/arm/availabilityset/availset.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the availability set name" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-t, --tags ", "required": -12, "optional": 0, "bool": true, "short": "-t", "long": "--tags", "description": "the semicolon separated list of tags" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" }, { "flags": "-a, --platform-update-domain-count ", "required": -36, "optional": 0, "bool": true, "short": "-a", "long": "--platform-update-domain-count", "description": "Set the platform-update-domain-count value." }, { "flags": "-b, --platform-fault-domain-count ", "required": -35, "optional": 0, "bool": true, "short": "-b", "long": "--platform-fault-domain-count", "description": "Set the platform-fault-domain-count value." } ] }, { "name": "list", "description": "Lists the availability sets within a resource group", "fullName": "availset list", "usage": "[options] ", "filePath": "commands/arm/availabilityset/availset.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "show", "description": "Gets one availability set within a resource group", "fullName": "availset show", "usage": "[options] ", "filePath": "commands/arm/availabilityset/availset.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the availability set name" }, { "flags": "-d, --depth ", "required": -13, "optional": 0, "bool": true, "short": "-d", "long": "--depth", "description": "the number of times to recurse, to recurse indefinitely pass \"full\". (valid only with --json option)" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "delete", "description": "Deletes one availability set within a resource group", "fullName": "availset delete", "usage": "[options] ", "filePath": "commands/arm/availabilityset/availset.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for delete confirmation" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list-available-sizes", "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", "fullName": "availset list-available-sizes", "usage": "[options] ", "filePath": "commands/arm/compute/availabilitySets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] } ], "categories": {} }, "cdn": { "name": "cdn", "description": "Commands to manage Azure Content Delivery Network (CDN)", "fullName": "cdn", "usage": "[options]", "options": [], "commands": [], "categories": { "profile": { "name": "profile", "description": "Commands to manage your Azure cdn profiles", "fullName": "cdn profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List all profiles under the current subscription", "fullName": "cdn profile list", "usage": "[options] [resource-group]", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group [resource-group]", "required": 0, "optional": -22, "bool": true, "short": "-g", "long": "--resource-group", "description": "Name of the Resource Group" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "show", "description": "Show the infomation of a specific cdn profile", "fullName": "cdn profile show", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name [name]", "required": 0, "optional": -12, "bool": true, "short": "-n", "long": "--name", "description": "Name of the Cdn Profile" }, { "flags": "-g, --resource-group [resource-group]", "required": 0, "optional": -22, "bool": true, "short": "-g", "long": "--resource-group", "description": "Name of the Resource Group" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "create", "description": "Create a profile under given resource group and subscription", "fullName": "cdn profile create", "usage": "[options] [tags]", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile will be created in" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "The location in which to create the Cdn Profile" }, { "flags": "-k, --sku-name ", "required": -16, "optional": 0, "bool": true, "short": "-k", "long": "--sku-name", "description": "The pricing sku name of the Azure Cdn Profile" }, { "flags": "-t, --tags [tags]", "required": 0, "optional": -12, "bool": true, "short": "-t", "long": "--tags", "description": "Tags to set to the profile. Can be multiple. In the format of 'name=value'. Name is required and value is optional." }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "delete", "description": "Delete a profile under given resource group and subscription", "fullName": "cdn profile delete", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile will be delete in" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "set", "description": "Update a profile's tags", "fullName": "cdn profile set", "usage": "[options] [tags]", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile will be created in" }, { "flags": "-t, --tags [tags]", "required": 0, "optional": -12, "bool": true, "short": "-t", "long": "--tags", "description": "Tags to set to the profile. Can be multiple. In the format of 'name=value'. Name is required and value is optional." }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] } ], "categories": {} }, "ssouri": { "name": "ssouri", "description": "Commands to generate sso uri of your Azure cdn profiles", "fullName": "cdn ssouri", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create sso uri of the profile", "fullName": "cdn ssouri create", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-n", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] } ], "categories": {} }, "endpoint": { "name": "endpoint", "description": "Commands to manage Azure cdn profile endpoints", "fullName": "cdn endpoint", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List endpoints by profile and resource group", "fullName": "cdn endpoint list", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-n", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "show", "description": "Get endpoint by endpoint name, profile name, and resource group", "fullName": "cdn endpoint show", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "create", "description": "Create endpoint with given name and properties.", "fullName": "cdn endpoint create", "usage": "[options] [origin-host-header] [origin-path] [content-type-to-compress] [is-compression-enabled] [is-http-allowed] [is-https-allowed] [query-string-caching-behavior] [http-port] [https-port] [tags]", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "The location of the Cdn endpoint" }, { "flags": "-o, --origin-name ", "required": -19, "optional": 0, "bool": true, "short": "-o", "long": "--origin-name", "description": "The name of the origin used to identify the origin" }, { "flags": "-r, --origin-host-name ", "required": -24, "optional": 0, "bool": true, "short": "-r", "long": "--origin-host-name", "description": "The host name of the origin" }, { "flags": "-e, --origin-host-header [origin-host-header]", "required": 0, "optional": -26, "bool": true, "short": "-e", "long": "--origin-host-header", "description": "The origin host header of the Azure Cdn Endpoint" }, { "flags": "-i, --origin-path [origin-path]", "required": 0, "optional": -19, "bool": true, "short": "-i", "long": "--origin-path", "description": "The origin path Azure Cdn Endpoint" }, { "flags": "-c, --content-types-to-compress [content-types-to-compress]", "required": 0, "optional": -33, "bool": true, "short": "-c", "long": "--content-types-to-compress", "description": "The list of mime types that need to be compressed by Cdn edge nodes" }, { "flags": "-d, --is-compression-enabled [is-compression-enabled]", "required": 0, "optional": -30, "bool": true, "short": "-d", "long": "--is-compression-enabled", "description": "Is the compression enabled for the Cdn. Valid input: -d [true|false]" }, { "flags": "-w, --is-http-allowed [is-http-allowed]", "required": 0, "optional": -23, "bool": true, "short": "-w", "long": "--is-http-allowed", "description": "Is the http traffic allowed for the Cdn. Valid input: -w [true|false]" }, { "flags": "-a, --is-https-allowed [is-https-allowed]", "required": 0, "optional": -24, "bool": true, "short": "-a", "long": "--is-https-allowed", "description": "Is the https traffic allowed for the Cdn. Valid input: -a [true|false]" }, { "flags": "-q, --query-string-caching-behavior [query-string-caching-behavior]", "required": 0, "optional": -37, "bool": true, "short": "-q", "long": "--query-string-caching-behavior", "description": "The way Cdn handles requests with query string" }, { "flags": "-u, --http-port [http-port]", "required": 0, "optional": -17, "bool": true, "short": "-u", "long": "--http-port", "description": "The port http traffic used on the origin server" }, { "flags": "-w, --https-port [https-port]", "required": 0, "optional": -18, "bool": true, "short": "-w", "long": "--https-port", "description": "The port https traffic used on the origin server" }, { "flags": "-t, --tags [tags]", "required": 0, "optional": -12, "bool": true, "short": "-t", "long": "--tags", "description": "The tags to associate with the Azure Cdn Endpoint" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "set", "description": "Update endpoint with given properties.", "fullName": "cdn endpoint set", "usage": "[options] [origin-host-header] [origin-path] [content-type-to-compress] [is-compression-enabled] [is-http-allowed] [is-https-allowed] [query-string-caching-behavior] [tags]", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "-e, --origin-host-header [origin-host-header]", "required": 0, "optional": -26, "bool": true, "short": "-e", "long": "--origin-host-header", "description": "The origin host header of the Azure Cdn Endpoint" }, { "flags": "-i, --origin-path [origin-path]", "required": 0, "optional": -19, "bool": true, "short": "-i", "long": "--origin-path", "description": "The origin path Azure Cdn Endpoint" }, { "flags": "-c, --content-types-to-compress [content-types-to-compress]", "required": 0, "optional": -33, "bool": true, "short": "-c", "long": "--content-types-to-compress", "description": "The list of mime types that need to be compressed by Cdn edge nodes" }, { "flags": "-d, --is-compression-enabled [is-compression-enabled]", "required": 0, "optional": -30, "bool": true, "short": "-d", "long": "--is-compression-enabled", "description": "Is the compression enabled for the Cdn. Valid input: -d [true|false]" }, { "flags": "-u, --is-http-allowed [is-http-allowed]", "required": 0, "optional": -23, "bool": true, "short": "-u", "long": "--is-http-allowed", "description": "Is the http traffic allowed for the Cdn. Valid input: -u [true|false]" }, { "flags": "-w, --is-https-allowed [is-https-allowed]", "required": 0, "optional": -24, "bool": true, "short": "-w", "long": "--is-https-allowed", "description": "Is the https traffic allowed for the Cdn. Valid input: -w [true|false]" }, { "flags": "-q, --query-string-caching-behavior [query-string-caching-behavior]", "required": 0, "optional": -37, "bool": true, "short": "-q", "long": "--query-string-caching-behavior", "description": "The way Cdn handles requests with query string" }, { "flags": "-t, --tags [tags]", "required": 0, "optional": -12, "bool": true, "short": "-t", "long": "--tags", "description": "The tags to associate with the Azure Cdn Endpoint" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "delete", "description": "Delete an endpoint by endpoint name, profile name, and resource group", "fullName": "cdn endpoint delete", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "start", "description": "Start an endpoint by endpoint name, profile name, and resource group", "fullName": "cdn endpoint start", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "stop", "description": "Stop an endpoint by endpoint name, profile name, and resource group", "fullName": "cdn endpoint stop", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "purge", "description": "Purge the content of the given paths in the endpoint", "fullName": "cdn endpoint purge", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "-c, --content-paths ", "required": -21, "optional": 0, "bool": true, "short": "-c", "long": "--content-paths", "description": "Content paths to be purged" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "load", "description": "Load the content of the given paths in the endpoint", "fullName": "cdn endpoint load", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "-c, --content-paths ", "required": -21, "optional": 0, "bool": true, "short": "-c", "long": "--content-paths", "description": "Content paths to be purged" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "check", "description": "Check if the endpoint name has been used or not", "fullName": "cdn endpoint check", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --endpoint-name ", "required": -21, "optional": 0, "bool": true, "short": "-n", "long": "--endpoint-name", "description": "Endpoint name" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] } ], "categories": {} }, "origin": { "name": "origin", "description": "Commands to manage Azure cdn profile endpoint origin", "fullName": "cdn origin", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Get origin by origin name, endpoint name, profile name, and resource group", "fullName": "cdn origin show", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the origin" }, { "flags": "-e, --endpoint-name ", "required": -21, "optional": 0, "bool": true, "short": "-e", "long": "--endpoint-name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "set", "description": "Update origin of the given origin name, endpoint name, profile name, and resource group", "fullName": "cdn origin set", "usage": "[options] [host-name] [http-port] [https-port]", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the origin" }, { "flags": "-e, --endpoint-name ", "required": -21, "optional": 0, "bool": true, "short": "-e", "long": "--endpoint-name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "-o, --host-name [host-name]", "required": 0, "optional": -17, "bool": true, "short": "-o", "long": "--host-name", "description": "Host name" }, { "flags": "-r, --http-port [http-port]", "required": 0, "optional": -17, "bool": true, "short": "-r", "long": "--http-port", "description": "Http port" }, { "flags": "-w, --https-port [https-port]", "required": 0, "optional": -18, "bool": true, "short": "-w", "long": "--https-port", "description": "Https port" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] } ], "categories": {} }, "customDomain": { "name": "customDomain", "description": "Commands to manage Azure cdn profile endpoint custom domain", "fullName": "cdn customDomain", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list", "description": "List custom domains by endpoint name, profile name, and resource group", "fullName": "cdn customDomain list", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-e, --endpoint-name ", "required": -21, "optional": 0, "bool": true, "short": "-e", "long": "--endpoint-name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "show", "description": "Get custom domains by custom domain name, endpoint name, profile name, and resource group", "fullName": "cdn customDomain show", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the custom domain" }, { "flags": "-e, --endpoint-name ", "required": -21, "optional": 0, "bool": true, "short": "-e", "long": "--endpoint-name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "create", "description": "Create a custom domain of a perticular custom domain host name", "fullName": "cdn customDomain create", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the custom domain" }, { "flags": "-e, --endpoint-name ", "required": -21, "optional": 0, "bool": true, "short": "-e", "long": "--endpoint-name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "-d, --custom-domain-host-name ", "required": -31, "optional": 0, "bool": true, "short": "-d", "long": "--custom-domain-host-name", "description": "The host name of the custom domain" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "delete", "description": "Delete a custom domain of a perticular custom domain host name", "fullName": "cdn customDomain delete", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "Name of the custom domain" }, { "flags": "-e, --endpoint-name ", "required": -21, "optional": 0, "bool": true, "short": "-e", "long": "--endpoint-name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "validate", "description": "Check to see if a custom domain host name is registered for cname mapping to the endpoint ", "fullName": "cdn customDomain validate", "usage": "[options] ", "filePath": "commands/arm/cdnmanagement/cdnmanagement.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-e, --endpoint-name ", "required": -21, "optional": 0, "bool": true, "short": "-e", "long": "--endpoint-name", "description": "Name of the endpoint" }, { "flags": "-p, --profile-name ", "required": -20, "optional": 0, "bool": true, "short": "-p", "long": "--profile-name", "description": "Name of the profile" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "The resource group of the Azure Cdn Profile" }, { "flags": "-d, --custom-domain-host-name ", "required": -31, "optional": 0, "bool": true, "short": "-d", "long": "--custom-domain-host-name", "description": "The host name of the custom domain" }, { "flags": "--subscription ", "required": -16, "optional": 0, "bool": true, "long": "--subscription", "description": "the subscription identifier" } ] } ], "categories": {} } } }, "vmssvm": { "name": "vmssvm", "description": "Commands to manage your virtual machine scale set vm. ", "fullName": "vmssvm", "usage": "[options] [command]", "options": [], "commands": [ { "name": "deallocate", "description": "Allows you to deallocate a virtual machine virtual machine scale set.Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", "fullName": "vmssvm deallocate", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-d, --instance-id ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--instance-id", "description": "instance-id" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "delete", "description": "Allows you to delete a virtual machine scale set.", "fullName": "vmssvm delete", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-d, --instance-id ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--instance-id", "description": "instance-id" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "show", "description": "Displays information about a virtual machine scale set virtual machine.", "fullName": "vmssvm show", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-d, --instance-id ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--instance-id", "description": "instance-id" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "get-instance-view", "description": "Displays the status of a virtual machine scale set virtual machine.", "fullName": "vmssvm get-instance-view", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-d, --instance-id ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--instance-id", "description": "instance-id" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "list", "description": "Lists all virtual machines in a VM scale sets.", "fullName": "vmssvm list", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "power-off", "description": "Allows you to power off (stop) a virtual machine in a VM scale set.", "fullName": "vmssvm power-off", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-d, --instance-id ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--instance-id", "description": "instance-id" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "reimage", "description": "Allows you to re-image(update the version of the installed operating system) a virtual machine scale set instance.", "fullName": "vmssvm reimage", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-d, --instance-id ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--instance-id", "description": "instance-id" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "restart", "description": "Allows you to restart a virtual machine in a VM scale set.", "fullName": "vmssvm restart", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-d, --instance-id ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--instance-id", "description": "instance-id" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "start", "description": "Allows you to start a virtual machine in a VM scale set.", "fullName": "vmssvm start", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSetVMs.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-d, --instance-id ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--instance-id", "description": "instance-id" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] } ], "categories": {} }, "vmss": { "name": "vmss", "description": "Commands to manage your virtual machine scale sets. ", "fullName": "vmss", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Allows you to create or update a virtual machine scale set by providing parameters or a path to pre-configured parameter file.", "fullName": "vmss create", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-p, --parameters ", "required": -18, "optional": 0, "bool": true, "short": "-p", "long": "--parameters", "description": "A string of parameters in JSON format" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The text file that contains input parameter object in JSON format" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "deallocate", "description": "Allows you to deallocate virtual machines in a virtual machine scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set uses.", "fullName": "vmss deallocate", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "--instance-ids ", "required": -16, "optional": 0, "bool": true, "long": "--instance-ids", "description": "instance-ids" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "delete", "description": "Allows you to delete a virtual machine scale set.", "fullName": "vmss delete", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "delete-instances", "description": "Allows you to delete virtual machines in a virtual machine scale set.", "fullName": "vmss delete-instances", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "--instance-ids ", "required": -16, "optional": 0, "bool": true, "long": "--instance-ids", "description": "instance-ids" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "show", "description": "Display information about a virtual machine scale set.", "fullName": "vmss show", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "get-instance-view", "description": "Displays status of a virtual machine scale set instance.", "fullName": "vmss get-instance-view", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "list", "description": "Lists all virtual machine scale sets under a resource group.", "fullName": "vmss list", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "list-skus", "description": "Displays available skus for your virtual machine scale set including the minimum and maximum vm instances allowed for a particular sku.", "fullName": "vmss list-skus", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "power-off", "description": "Allows you to power off (stop) virtual machines in a virtual machine scale set. Note that resources are still attached and you are getting charged for the resources. Use deallocate to release resources.", "fullName": "vmss power-off", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "--instance-ids ", "required": -16, "optional": 0, "bool": true, "long": "--instance-ids", "description": "instance-ids" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "reimage", "description": "Allows you to re-image(update the version of the installed operating system) virtual machines in a virtual machine scale set.", "fullName": "vmss reimage", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "restart", "description": "Allows you to restart virtual machines in a virtual machine scale set.", "fullName": "vmss restart", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "--instance-ids ", "required": -16, "optional": 0, "bool": true, "long": "--instance-ids", "description": "instance-ids" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "start", "description": "Allows you to start virtual machines in a virtual machine scale set.", "fullName": "vmss start", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "--instance-ids ", "required": -16, "optional": 0, "bool": true, "long": "--instance-ids", "description": "instance-ids" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "update-instances", "description": "Allows you to manually upgrade virtual machines in a virtual machine scale set.", "fullName": "vmss update-instances", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "--instance-ids ", "required": -16, "optional": 0, "bool": true, "long": "--instance-ids", "description": "instance-ids" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "quick-create", "description": "Commands to create a virtual machine scale set with default resources in a group.\n For 'image-urn' refer the following command: $ azure vm image list (Example: $ azure vm image list westus canonical)", "fullName": "vmss quick-create", "usage": "[options] [resource-group-name] [name] [location] [image-urn] [capacity] [admin-username] [admin-password]", "filePath": "commands/arm/vmss/vmss.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group-name ", "required": -27, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group-name", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name prefix" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-Q, --image-urn ", "required": -17, "optional": 0, "bool": true, "short": "-Q", "long": "--image-urn", "description": "the image reference, e.g. \"publisher:offer:skus:version\"\n URN Aliases:\n Win2012R2Datacenter = MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter:latest\n Win2012Datacenter = MicrosoftWindowsServer:WindowsServer:2012-Datacenter:latest\n Win2008R2SP1 = MicrosoftWindowsServer:WindowsServer:2008-R2-SP1:latest\n CentOS = OpenLogic:CentOS:7.2:latest\n CoreOS = CoreOS:CoreOS:Stable:latest\n Debian = credativ:Debian:8:latest\n openSUSE = SUSE:openSUSE:13.2:latest\n RHEL = RedHat:RHEL:7.2:latest\n SLES = SUSE:SLES:12-SP1:latest\n UbuntuLTS = Canonical:UbuntuServer:14.04.4-LTS:latest" }, { "flags": "-u, --admin-username ", "required": -22, "optional": 0, "bool": true, "short": "-u", "long": "--admin-username", "description": "the user name" }, { "flags": "-p, --admin-password ", "required": -22, "optional": 0, "bool": true, "short": "-p", "long": "--admin-password", "description": "the password" }, { "flags": "-z, --vm-size ", "required": -15, "optional": 0, "bool": true, "short": "-z", "long": "--vm-size", "description": "Optional, the virtual machine size, by default [Standard_DS1]" }, { "flags": "-C, --capacity ", "required": -16, "optional": 0, "bool": true, "short": "-C", "long": "--capacity", "description": "the virtual machine scale set capacity, i.e. number of instances (5 by default)" }, { "flags": "-M, --ssh-public-key-file ", "required": -27, "optional": 0, "bool": true, "short": "-M", "long": "--ssh-public-key-file", "description": "the path to public key file for SSH authentication,\n & this parameter is valid only when os-type is Linux." }, { "flags": "-a, --storage-type ", "required": -20, "optional": 0, "bool": true, "short": "-a", "long": "--storage-type", "description": "Optional, the storage type, by default [Premium_LRS]" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "scale", "description": "The operation to scale virtual machine scale set", "fullName": "vmss scale", "usage": "[options] ", "filePath": "commands/arm/vmss/vmss.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "name" }, { "flags": "-C, --new-capacity ", "required": -20, "optional": 0, "bool": true, "short": "-C", "long": "--new-capacity", "description": "the new capacity value" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] } ], "categories": { "config": { "name": "config", "description": "Commands to manage configuration of virtual-machine-scale-sets in the parameter file.", "fullName": "vmss config", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate virtualMachineScaleSetsCreateOrUpdate parameter string or files.", "fullName": "vmss config create", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." } ] }, { "name": "patch", "description": "Command to patch virtualMachineScaleSetsCreateOrUpdate parameter JSON file.", "fullName": "vmss config patch", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--operation ", "required": -13, "optional": 0, "bool": true, "long": "--operation", "description": "The JSON patch operation: add, remove, or replace." }, { "flags": "--path ", "required": -8, "optional": 0, "bool": true, "long": "--path", "description": "The JSON data path, e.g.: \"foo/1\"." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The JSON value." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the JSON value to object." } ] } ], "categories": { "virtual-machine-scale-set": { "name": "virtual-machine-scale-set", "description": "Commands to configure virtual-machine-scale-set of vmss in config file.", "fullName": "vmss config virtual-machine-scale-set", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set virtual-machine-scale-set in config string or files, e.g. \r\n{\r\n \"sku\":{\r\n \"name\":\"\",\r\n \"tier\":\"\",\r\n \"capacity\":null\r\n },\r\n \"upgradePolicy\":{\r\n \"mode\":null\r\n },\r\n \"virtualMachineProfile\":{\r\n \"osProfile\":{\r\n \"computerNamePrefix\":\"\",\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\",\r\n \"customData\":\"\",\r\n \"windowsConfiguration\":{\r\n \"provisionVMAgent\":null,\r\n \"enableAutomaticUpdates\":null,\r\n \"timeZone\":\"\",\r\n \"additionalUnattendContent\":[\r\n {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ],\r\n \"winRM\":{\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"linuxConfiguration\":{\r\n \"disablePasswordAuthentication\":null,\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"secrets\":[\r\n {\r\n \"sourceVault\":{\r\n \"id\":\"\"\r\n },\r\n \"vaultCertificates\":[\r\n {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"storageProfile\":{\r\n \"imageReference\":{\r\n \"publisher\":\"\",\r\n \"offer\":\"\",\r\n \"sku\":\"\",\r\n \"version\":\"\"\r\n },\r\n \"osDisk\":{\r\n \"name\":\"\",\r\n \"caching\":null,\r\n \"createOption\":\"\",\r\n \"osType\":null,\r\n \"image\":{\r\n \"uri\":\"\"\r\n },\r\n \"vhdContainers\":[\r\n \"\"\r\n ]\r\n }\r\n },\r\n \"networkProfile\":{\r\n \"networkInterfaceConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"primary\":null,\r\n \"ipConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ]\r\n },\r\n \"extensionProfile\":{\r\n \"extensions\":[\r\n {\r\n \"name\":\"\",\r\n \"publisher\":\"\",\r\n \"type\":\"\",\r\n \"typeHandlerVersion\":\"\",\r\n \"autoUpgradeMinorVersion\":null,\r\n \"settings\":{\r\n },\r\n \"protectedSettings\":{\r\n },\r\n \"provisioningState\":\"\",\r\n \"id\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"provisioningState\":\"\",\r\n \"overProvision\":null,\r\n \"id\":null,\r\n \"name\":null,\r\n \"type\":null,\r\n \"location\":\"\",\r\n \"tags\":{\r\n }\r\n}\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config virtual-machine-scale-set set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--sku ", "required": -7, "optional": 0, "bool": true, "long": "--sku", "description": "Set the sku value." }, { "flags": "--upgrade-policy ", "required": -18, "optional": 0, "bool": true, "long": "--upgrade-policy", "description": "Set the upgrade-policy value." }, { "flags": "--virtual-machine-profile ", "required": -27, "optional": 0, "bool": true, "long": "--virtual-machine-profile", "description": "Set the virtual-machine-profile value." }, { "flags": "--provisioning-state ", "required": -22, "optional": 0, "bool": true, "long": "--provisioning-state", "description": "Set the provisioning-state value." }, { "flags": "--over-provision ", "required": -18, "optional": 0, "bool": true, "long": "--over-provision", "description": "Set the over-provision value." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "Set the name value." }, { "flags": "--type ", "required": -8, "optional": 0, "bool": true, "long": "--type", "description": "Set the type value." }, { "flags": "--location ", "required": -12, "optional": 0, "bool": true, "long": "--location", "description": "Set the location value." }, { "flags": "--tags ", "required": -8, "optional": 0, "bool": true, "long": "--tags", "description": "Set the tags value." } ] }, { "name": "delete", "description": "Remove virtual-machine-scale-set in config string or files, e.g. \r\n{\r\n \"sku\":{\r\n \"name\":\"\",\r\n \"tier\":\"\",\r\n \"capacity\":null\r\n },\r\n \"upgradePolicy\":{\r\n \"mode\":null\r\n },\r\n \"virtualMachineProfile\":{\r\n \"osProfile\":{\r\n \"computerNamePrefix\":\"\",\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\",\r\n \"customData\":\"\",\r\n \"windowsConfiguration\":{\r\n \"provisionVMAgent\":null,\r\n \"enableAutomaticUpdates\":null,\r\n \"timeZone\":\"\",\r\n \"additionalUnattendContent\":[\r\n {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ],\r\n \"winRM\":{\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"linuxConfiguration\":{\r\n \"disablePasswordAuthentication\":null,\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"secrets\":[\r\n {\r\n \"sourceVault\":{\r\n \"id\":\"\"\r\n },\r\n \"vaultCertificates\":[\r\n {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"storageProfile\":{\r\n \"imageReference\":{\r\n \"publisher\":\"\",\r\n \"offer\":\"\",\r\n \"sku\":\"\",\r\n \"version\":\"\"\r\n },\r\n \"osDisk\":{\r\n \"name\":\"\",\r\n \"caching\":null,\r\n \"createOption\":\"\",\r\n \"osType\":null,\r\n \"image\":{\r\n \"uri\":\"\"\r\n },\r\n \"vhdContainers\":[\r\n \"\"\r\n ]\r\n }\r\n },\r\n \"networkProfile\":{\r\n \"networkInterfaceConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"primary\":null,\r\n \"ipConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ]\r\n },\r\n \"extensionProfile\":{\r\n \"extensions\":[\r\n {\r\n \"name\":\"\",\r\n \"publisher\":\"\",\r\n \"type\":\"\",\r\n \"typeHandlerVersion\":\"\",\r\n \"autoUpgradeMinorVersion\":null,\r\n \"settings\":{\r\n },\r\n \"protectedSettings\":{\r\n },\r\n \"provisioningState\":\"\",\r\n \"id\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"provisioningState\":\"\",\r\n \"overProvision\":null,\r\n \"id\":null,\r\n \"name\":null,\r\n \"type\":null,\r\n \"location\":\"\",\r\n \"tags\":{\r\n }\r\n}\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config virtual-machine-scale-set delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--sku", "required": 0, "optional": 0, "bool": true, "long": "--sku", "description": "Remove the sku value." }, { "flags": "--upgrade-policy", "required": 0, "optional": 0, "bool": true, "long": "--upgrade-policy", "description": "Remove the upgrade-policy value." }, { "flags": "--virtual-machine-profile", "required": 0, "optional": 0, "bool": true, "long": "--virtual-machine-profile", "description": "Remove the virtual-machine-profile value." }, { "flags": "--provisioning-state", "required": 0, "optional": 0, "bool": true, "long": "--provisioning-state", "description": "Remove the provisioning-state value." }, { "flags": "--over-provision", "required": 0, "optional": 0, "bool": true, "long": "--over-provision", "description": "Remove the over-provision value." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." }, { "flags": "--name", "required": 0, "optional": 0, "bool": true, "long": "--name", "description": "Remove the name value." }, { "flags": "--type", "required": 0, "optional": 0, "bool": true, "long": "--type", "description": "Remove the type value." }, { "flags": "--location", "required": 0, "optional": 0, "bool": true, "long": "--location", "description": "Remove the location value." }, { "flags": "--tags", "required": 0, "optional": 0, "bool": true, "long": "--tags", "description": "Remove the tags value." } ] } ], "categories": {} }, "sku": { "name": "sku", "description": "Commands to configure sku of vmss in config file.", "fullName": "vmss config sku", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set sku in config string or files, e.g. \r\n {\r\n ...\r\n \"sku\" : {\r\n \"name\":\"\",\r\n \"tier\":\"\",\r\n \"capacity\":null\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config sku set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "Set the name value." }, { "flags": "--tier ", "required": -8, "optional": 0, "bool": true, "long": "--tier", "description": "Set the tier value." }, { "flags": "--capacity ", "required": -12, "optional": 0, "bool": true, "long": "--capacity", "description": "Set the capacity value." } ] }, { "name": "delete", "description": "Remove sku in config string or files, e.g. \r\n {\r\n ...\r\n \"sku\" : {\r\n \"name\":\"\",\r\n \"tier\":\"\",\r\n \"capacity\":null\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config sku delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--name", "required": 0, "optional": 0, "bool": true, "long": "--name", "description": "Remove the name value." }, { "flags": "--tier", "required": 0, "optional": 0, "bool": true, "long": "--tier", "description": "Remove the tier value." }, { "flags": "--capacity", "required": 0, "optional": 0, "bool": true, "long": "--capacity", "description": "Remove the capacity value." } ] } ], "categories": {} }, "upgrade-policy": { "name": "upgrade-policy", "description": "Commands to configure upgrade-policy of vmss in config file.", "fullName": "vmss config upgrade-policy", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set upgrade-policy in config string or files, e.g. \r\n {\r\n ...\r\n \"upgradePolicy\" : {\r\n \"mode\":null\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config upgrade-policy set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--mode ", "required": -8, "optional": 0, "bool": true, "long": "--mode", "description": "Set the mode value." } ] }, { "name": "delete", "description": "Remove upgrade-policy in config string or files, e.g. \r\n {\r\n ...\r\n \"upgradePolicy\" : {\r\n \"mode\":null\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config upgrade-policy delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--mode", "required": 0, "optional": 0, "bool": true, "long": "--mode", "description": "Remove the mode value." } ] } ], "categories": {} }, "virtual-machine-profile": { "name": "virtual-machine-profile", "description": "Commands to configure virtual-machine-profile of vmss in config file.", "fullName": "vmss config virtual-machine-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set virtual-machine-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"virtualMachineProfile\" : {\r\n \"osProfile\":{\r\n \"computerNamePrefix\":\"\",\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\",\r\n \"customData\":\"\",\r\n \"windowsConfiguration\":{\r\n \"provisionVMAgent\":null,\r\n \"enableAutomaticUpdates\":null,\r\n \"timeZone\":\"\",\r\n \"additionalUnattendContent\":[\r\n {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ],\r\n \"winRM\":{\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"linuxConfiguration\":{\r\n \"disablePasswordAuthentication\":null,\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"secrets\":[\r\n {\r\n \"sourceVault\":{\r\n \"id\":\"\"\r\n },\r\n \"vaultCertificates\":[\r\n {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"storageProfile\":{\r\n \"imageReference\":{\r\n \"publisher\":\"\",\r\n \"offer\":\"\",\r\n \"sku\":\"\",\r\n \"version\":\"\"\r\n },\r\n \"osDisk\":{\r\n \"name\":\"\",\r\n \"caching\":null,\r\n \"createOption\":\"\",\r\n \"osType\":null,\r\n \"image\":{\r\n \"uri\":\"\"\r\n },\r\n \"vhdContainers\":[\r\n \"\"\r\n ]\r\n }\r\n },\r\n \"networkProfile\":{\r\n \"networkInterfaceConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"primary\":null,\r\n \"ipConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ]\r\n },\r\n \"extensionProfile\":{\r\n \"extensions\":[\r\n {\r\n \"name\":\"\",\r\n \"publisher\":\"\",\r\n \"type\":\"\",\r\n \"typeHandlerVersion\":\"\",\r\n \"autoUpgradeMinorVersion\":null,\r\n \"settings\":{\r\n },\r\n \"protectedSettings\":{\r\n },\r\n \"provisioningState\":\"\",\r\n \"id\":\"\"\r\n }\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config virtual-machine-profile set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--os-profile ", "required": -14, "optional": 0, "bool": true, "long": "--os-profile", "description": "Set the os-profile value." }, { "flags": "--storage-profile ", "required": -19, "optional": 0, "bool": true, "long": "--storage-profile", "description": "Set the storage-profile value." }, { "flags": "--network-profile ", "required": -19, "optional": 0, "bool": true, "long": "--network-profile", "description": "Set the network-profile value." }, { "flags": "--extension-profile ", "required": -21, "optional": 0, "bool": true, "long": "--extension-profile", "description": "Set the extension-profile value." } ] }, { "name": "delete", "description": "Remove virtual-machine-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"virtualMachineProfile\" : {\r\n \"osProfile\":{\r\n \"computerNamePrefix\":\"\",\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\",\r\n \"customData\":\"\",\r\n \"windowsConfiguration\":{\r\n \"provisionVMAgent\":null,\r\n \"enableAutomaticUpdates\":null,\r\n \"timeZone\":\"\",\r\n \"additionalUnattendContent\":[\r\n {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ],\r\n \"winRM\":{\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"linuxConfiguration\":{\r\n \"disablePasswordAuthentication\":null,\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"secrets\":[\r\n {\r\n \"sourceVault\":{\r\n \"id\":\"\"\r\n },\r\n \"vaultCertificates\":[\r\n {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"storageProfile\":{\r\n \"imageReference\":{\r\n \"publisher\":\"\",\r\n \"offer\":\"\",\r\n \"sku\":\"\",\r\n \"version\":\"\"\r\n },\r\n \"osDisk\":{\r\n \"name\":\"\",\r\n \"caching\":null,\r\n \"createOption\":\"\",\r\n \"osType\":null,\r\n \"image\":{\r\n \"uri\":\"\"\r\n },\r\n \"vhdContainers\":[\r\n \"\"\r\n ]\r\n }\r\n },\r\n \"networkProfile\":{\r\n \"networkInterfaceConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"primary\":null,\r\n \"ipConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ]\r\n },\r\n \"extensionProfile\":{\r\n \"extensions\":[\r\n {\r\n \"name\":\"\",\r\n \"publisher\":\"\",\r\n \"type\":\"\",\r\n \"typeHandlerVersion\":\"\",\r\n \"autoUpgradeMinorVersion\":null,\r\n \"settings\":{\r\n },\r\n \"protectedSettings\":{\r\n },\r\n \"provisioningState\":\"\",\r\n \"id\":\"\"\r\n }\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config virtual-machine-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--os-profile", "required": 0, "optional": 0, "bool": true, "long": "--os-profile", "description": "Remove the os-profile value." }, { "flags": "--storage-profile", "required": 0, "optional": 0, "bool": true, "long": "--storage-profile", "description": "Remove the storage-profile value." }, { "flags": "--network-profile", "required": 0, "optional": 0, "bool": true, "long": "--network-profile", "description": "Remove the network-profile value." }, { "flags": "--extension-profile", "required": 0, "optional": 0, "bool": true, "long": "--extension-profile", "description": "Remove the extension-profile value." } ] } ], "categories": {} }, "os-profile": { "name": "os-profile", "description": "Commands to configure os-profile of vmss in config file.", "fullName": "vmss config os-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set os-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"osProfile\" : {\r\n \"computerNamePrefix\":\"\",\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\",\r\n \"customData\":\"\",\r\n \"windowsConfiguration\":{\r\n \"provisionVMAgent\":null,\r\n \"enableAutomaticUpdates\":null,\r\n \"timeZone\":\"\",\r\n \"additionalUnattendContent\":[\r\n {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ],\r\n \"winRM\":{\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"linuxConfiguration\":{\r\n \"disablePasswordAuthentication\":null,\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"secrets\":[\r\n {\r\n \"sourceVault\":{\r\n \"id\":\"\"\r\n },\r\n \"vaultCertificates\":[\r\n {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config os-profile set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--computer-name-prefix ", "required": -24, "optional": 0, "bool": true, "long": "--computer-name-prefix", "description": "Set the computer-name-prefix value." }, { "flags": "--admin-username ", "required": -18, "optional": 0, "bool": true, "long": "--admin-username", "description": "Set the admin-username value." }, { "flags": "--admin-password ", "required": -18, "optional": 0, "bool": true, "long": "--admin-password", "description": "Set the admin-password value." }, { "flags": "--custom-data ", "required": -15, "optional": 0, "bool": true, "long": "--custom-data", "description": "Set the custom-data value." }, { "flags": "--windows-configuration ", "required": -25, "optional": 0, "bool": true, "long": "--windows-configuration", "description": "Set the windows-configuration value." }, { "flags": "--linux-configuration ", "required": -23, "optional": 0, "bool": true, "long": "--linux-configuration", "description": "Set the linux-configuration value." }, { "flags": "--secrets ", "required": -11, "optional": 0, "bool": true, "long": "--secrets", "description": "Set the secrets value." } ] }, { "name": "delete", "description": "Remove os-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"osProfile\" : {\r\n \"computerNamePrefix\":\"\",\r\n \"adminUsername\":\"\",\r\n \"adminPassword\":\"\",\r\n \"customData\":\"\",\r\n \"windowsConfiguration\":{\r\n \"provisionVMAgent\":null,\r\n \"enableAutomaticUpdates\":null,\r\n \"timeZone\":\"\",\r\n \"additionalUnattendContent\":[\r\n {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ],\r\n \"winRM\":{\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"linuxConfiguration\":{\r\n \"disablePasswordAuthentication\":null,\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n },\r\n \"secrets\":[\r\n {\r\n \"sourceVault\":{\r\n \"id\":\"\"\r\n },\r\n \"vaultCertificates\":[\r\n {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config os-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--computer-name-prefix", "required": 0, "optional": 0, "bool": true, "long": "--computer-name-prefix", "description": "Remove the computer-name-prefix value." }, { "flags": "--admin-username", "required": 0, "optional": 0, "bool": true, "long": "--admin-username", "description": "Remove the admin-username value." }, { "flags": "--admin-password", "required": 0, "optional": 0, "bool": true, "long": "--admin-password", "description": "Remove the admin-password value." }, { "flags": "--custom-data", "required": 0, "optional": 0, "bool": true, "long": "--custom-data", "description": "Remove the custom-data value." }, { "flags": "--windows-configuration", "required": 0, "optional": 0, "bool": true, "long": "--windows-configuration", "description": "Remove the windows-configuration value." }, { "flags": "--linux-configuration", "required": 0, "optional": 0, "bool": true, "long": "--linux-configuration", "description": "Remove the linux-configuration value." }, { "flags": "--secrets", "required": 0, "optional": 0, "bool": true, "long": "--secrets", "description": "Remove the secrets value." } ] } ], "categories": {} }, "windows-configuration": { "name": "windows-configuration", "description": "Commands to configure windows-configuration of vmss in config file.", "fullName": "vmss config windows-configuration", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set windows-configuration in config string or files, e.g. \r\n {\r\n ...\r\n \"windowsConfiguration\" : {\r\n \"provisionVMAgent\":null,\r\n \"enableAutomaticUpdates\":null,\r\n \"timeZone\":\"\",\r\n \"additionalUnattendContent\":[\r\n {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ],\r\n \"winRM\":{\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config windows-configuration set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--provision-vm-agent ", "required": -22, "optional": 0, "bool": true, "long": "--provision-vm-agent", "description": "Set the provision-vm-agent value." }, { "flags": "--enable-automatic-updates ", "required": -28, "optional": 0, "bool": true, "long": "--enable-automatic-updates", "description": "Set the enable-automatic-updates value." }, { "flags": "--time-zone ", "required": -13, "optional": 0, "bool": true, "long": "--time-zone", "description": "Set the time-zone value." }, { "flags": "--additional-unattend-content ", "required": -31, "optional": 0, "bool": true, "long": "--additional-unattend-content", "description": "Set the additional-unattend-content value." }, { "flags": "--win-rm ", "required": -10, "optional": 0, "bool": true, "long": "--win-rm", "description": "Set the win-rm value." } ] }, { "name": "delete", "description": "Remove windows-configuration in config string or files, e.g. \r\n {\r\n ...\r\n \"windowsConfiguration\" : {\r\n \"provisionVMAgent\":null,\r\n \"enableAutomaticUpdates\":null,\r\n \"timeZone\":\"\",\r\n \"additionalUnattendContent\":[\r\n {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ],\r\n \"winRM\":{\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config windows-configuration delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--provision-vm-agent", "required": 0, "optional": 0, "bool": true, "long": "--provision-vm-agent", "description": "Remove the provision-vm-agent value." }, { "flags": "--enable-automatic-updates", "required": 0, "optional": 0, "bool": true, "long": "--enable-automatic-updates", "description": "Remove the enable-automatic-updates value." }, { "flags": "--time-zone", "required": 0, "optional": 0, "bool": true, "long": "--time-zone", "description": "Remove the time-zone value." }, { "flags": "--additional-unattend-content", "required": 0, "optional": 0, "bool": true, "long": "--additional-unattend-content", "description": "Remove the additional-unattend-content value." }, { "flags": "--win-rm", "required": 0, "optional": 0, "bool": true, "long": "--win-rm", "description": "Remove the win-rm value." } ] } ], "categories": {} }, "additional-unattend-content": { "name": "additional-unattend-content", "description": "Commands to configure additional-unattend-content of vmss in config file.", "fullName": "vmss config additional-unattend-content", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set additional-unattend-content in config string or files, e.g. \r\n {\r\n ...\r\n \"additionalUnattendContent\" : {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config additional-unattend-content set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--pass-name ", "required": -13, "optional": 0, "bool": true, "long": "--pass-name", "description": "Set the pass-name value." }, { "flags": "--component-name ", "required": -18, "optional": 0, "bool": true, "long": "--component-name", "description": "Set the component-name value." }, { "flags": "--setting-name ", "required": -16, "optional": 0, "bool": true, "long": "--setting-name", "description": "Set the setting-name value." }, { "flags": "--content ", "required": -11, "optional": 0, "bool": true, "long": "--content", "description": "Set the content value." } ] }, { "name": "delete", "description": "Remove additional-unattend-content in config string or files, e.g. \r\n {\r\n ...\r\n \"additionalUnattendContent\" : {\r\n \"passName\":null,\r\n \"componentName\":null,\r\n \"settingName\":null,\r\n \"content\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config additional-unattend-content delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--pass-name", "required": 0, "optional": 0, "bool": true, "long": "--pass-name", "description": "Remove the pass-name value." }, { "flags": "--component-name", "required": 0, "optional": 0, "bool": true, "long": "--component-name", "description": "Remove the component-name value." }, { "flags": "--setting-name", "required": 0, "optional": 0, "bool": true, "long": "--setting-name", "description": "Remove the setting-name value." }, { "flags": "--content", "required": 0, "optional": 0, "bool": true, "long": "--content", "description": "Remove the content value." } ] } ], "categories": {} }, "win-rm": { "name": "win-rm", "description": "Commands to configure win-rm of vmss in config file.", "fullName": "vmss config win-rm", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set win-rm in config string or files, e.g. \r\n {\r\n ...\r\n \"winRM\" : {\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config win-rm set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--listeners ", "required": -13, "optional": 0, "bool": true, "long": "--listeners", "description": "Set the listeners value." } ] }, { "name": "delete", "description": "Remove win-rm in config string or files, e.g. \r\n {\r\n ...\r\n \"winRM\" : {\r\n \"listeners\":[\r\n {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config win-rm delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--listeners", "required": 0, "optional": 0, "bool": true, "long": "--listeners", "description": "Remove the listeners value." } ] } ], "categories": {} }, "listeners": { "name": "listeners", "description": "Commands to configure listeners of vmss in config file.", "fullName": "vmss config listeners", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set listeners in config string or files, e.g. \r\n {\r\n ...\r\n \"listeners\" : {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config listeners set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--protocol ", "required": -12, "optional": 0, "bool": true, "long": "--protocol", "description": "Set the protocol value." }, { "flags": "--certificate-url ", "required": -19, "optional": 0, "bool": true, "long": "--certificate-url", "description": "Set the certificate-url value." } ] }, { "name": "delete", "description": "Remove listeners in config string or files, e.g. \r\n {\r\n ...\r\n \"listeners\" : {\r\n \"protocol\":null,\r\n \"certificateUrl\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config listeners delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--protocol", "required": 0, "optional": 0, "bool": true, "long": "--protocol", "description": "Remove the protocol value." }, { "flags": "--certificate-url", "required": 0, "optional": 0, "bool": true, "long": "--certificate-url", "description": "Remove the certificate-url value." } ] } ], "categories": {} }, "linux-configuration": { "name": "linux-configuration", "description": "Commands to configure linux-configuration of vmss in config file.", "fullName": "vmss config linux-configuration", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set linux-configuration in config string or files, e.g. \r\n {\r\n ...\r\n \"linuxConfiguration\" : {\r\n \"disablePasswordAuthentication\":null,\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config linux-configuration set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--disable-password-authentication ", "required": -35, "optional": 0, "bool": true, "long": "--disable-password-authentication", "description": "Set the disable-password-authentication value." }, { "flags": "--ssh ", "required": -7, "optional": 0, "bool": true, "long": "--ssh", "description": "Set the ssh value." } ] }, { "name": "delete", "description": "Remove linux-configuration in config string or files, e.g. \r\n {\r\n ...\r\n \"linuxConfiguration\" : {\r\n \"disablePasswordAuthentication\":null,\r\n \"ssh\":{\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config linux-configuration delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--disable-password-authentication", "required": 0, "optional": 0, "bool": true, "long": "--disable-password-authentication", "description": "Remove the disable-password-authentication value." }, { "flags": "--ssh", "required": 0, "optional": 0, "bool": true, "long": "--ssh", "description": "Remove the ssh value." } ] } ], "categories": {} }, "ssh": { "name": "ssh", "description": "Commands to configure ssh of vmss in config file.", "fullName": "vmss config ssh", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set ssh in config string or files, e.g. \r\n {\r\n ...\r\n \"ssh\" : {\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config ssh set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--public-keys ", "required": -15, "optional": 0, "bool": true, "long": "--public-keys", "description": "Set the public-keys value." } ] }, { "name": "delete", "description": "Remove ssh in config string or files, e.g. \r\n {\r\n ...\r\n \"ssh\" : {\r\n \"publicKeys\":[\r\n {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config ssh delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--public-keys", "required": 0, "optional": 0, "bool": true, "long": "--public-keys", "description": "Remove the public-keys value." } ] } ], "categories": {} }, "public-keys": { "name": "public-keys", "description": "Commands to configure public-keys of vmss in config file.", "fullName": "vmss config public-keys", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set public-keys in config string or files, e.g. \r\n {\r\n ...\r\n \"publicKeys\" : {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config public-keys set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--path ", "required": -8, "optional": 0, "bool": true, "long": "--path", "description": "Set the path value." }, { "flags": "--key-data ", "required": -12, "optional": 0, "bool": true, "long": "--key-data", "description": "Set the key-data value." } ] }, { "name": "delete", "description": "Remove public-keys in config string or files, e.g. \r\n {\r\n ...\r\n \"publicKeys\" : {\r\n \"path\":\"\",\r\n \"keyData\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config public-keys delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--path", "required": 0, "optional": 0, "bool": true, "long": "--path", "description": "Remove the path value." }, { "flags": "--key-data", "required": 0, "optional": 0, "bool": true, "long": "--key-data", "description": "Remove the key-data value." } ] } ], "categories": {} }, "secrets": { "name": "secrets", "description": "Commands to configure secrets of vmss in config file.", "fullName": "vmss config secrets", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set secrets in config string or files, e.g. \r\n {\r\n ...\r\n \"secrets\" : {\r\n \"sourceVault\":{\r\n \"id\":\"\"\r\n },\r\n \"vaultCertificates\":[\r\n {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config secrets set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--source-vault ", "required": -16, "optional": 0, "bool": true, "long": "--source-vault", "description": "Set the source-vault value." }, { "flags": "--vault-certificates ", "required": -22, "optional": 0, "bool": true, "long": "--vault-certificates", "description": "Set the vault-certificates value." } ] }, { "name": "delete", "description": "Remove secrets in config string or files, e.g. \r\n {\r\n ...\r\n \"secrets\" : {\r\n \"sourceVault\":{\r\n \"id\":\"\"\r\n },\r\n \"vaultCertificates\":[\r\n {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config secrets delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--source-vault", "required": 0, "optional": 0, "bool": true, "long": "--source-vault", "description": "Remove the source-vault value." }, { "flags": "--vault-certificates", "required": 0, "optional": 0, "bool": true, "long": "--vault-certificates", "description": "Remove the vault-certificates value." } ] } ], "categories": {} }, "source-vault": { "name": "source-vault", "description": "Commands to configure source-vault of vmss in config file.", "fullName": "vmss config source-vault", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set source-vault in config string or files, e.g. \r\n {\r\n ...\r\n \"sourceVault\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config source-vault set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--secrets-index ", "required": -17, "optional": 0, "bool": true, "long": "--secrets-index", "description": "Indexer: secrets-index." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove source-vault in config string or files, e.g. \r\n {\r\n ...\r\n \"sourceVault\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config source-vault delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--secrets-index ", "required": -17, "optional": 0, "bool": true, "long": "--secrets-index", "description": "Indexer: secrets-index." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} }, "vault-certificates": { "name": "vault-certificates", "description": "Commands to configure vault-certificates of vmss in config file.", "fullName": "vmss config vault-certificates", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set vault-certificates in config string or files, e.g. \r\n {\r\n ...\r\n \"vaultCertificates\" : {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config vault-certificates set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--secrets-index ", "required": -17, "optional": 0, "bool": true, "long": "--secrets-index", "description": "Indexer: secrets-index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--certificate-url ", "required": -19, "optional": 0, "bool": true, "long": "--certificate-url", "description": "Set the certificate-url value." }, { "flags": "--certificate-store ", "required": -21, "optional": 0, "bool": true, "long": "--certificate-store", "description": "Set the certificate-store value." } ] }, { "name": "delete", "description": "Remove vault-certificates in config string or files, e.g. \r\n {\r\n ...\r\n \"vaultCertificates\" : {\r\n \"certificateUrl\":\"\",\r\n \"certificateStore\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config vault-certificates delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--secrets-index ", "required": -17, "optional": 0, "bool": true, "long": "--secrets-index", "description": "Indexer: secrets-index." }, { "flags": "--certificate-url", "required": 0, "optional": 0, "bool": true, "long": "--certificate-url", "description": "Remove the certificate-url value." }, { "flags": "--certificate-store", "required": 0, "optional": 0, "bool": true, "long": "--certificate-store", "description": "Remove the certificate-store value." } ] } ], "categories": {} }, "storage-profile": { "name": "storage-profile", "description": "Commands to configure storage-profile of vmss in config file.", "fullName": "vmss config storage-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set storage-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"storageProfile\" : {\r\n \"imageReference\":{\r\n \"publisher\":\"\",\r\n \"offer\":\"\",\r\n \"sku\":\"\",\r\n \"version\":\"\"\r\n },\r\n \"osDisk\":{\r\n \"name\":\"\",\r\n \"caching\":null,\r\n \"createOption\":\"\",\r\n \"osType\":null,\r\n \"image\":{\r\n \"uri\":\"\"\r\n },\r\n \"vhdContainers\":[\r\n \"\"\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config storage-profile set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--image-reference ", "required": -19, "optional": 0, "bool": true, "long": "--image-reference", "description": "Set the image-reference value." }, { "flags": "--os-disk ", "required": -11, "optional": 0, "bool": true, "long": "--os-disk", "description": "Set the os-disk value." } ] }, { "name": "delete", "description": "Remove storage-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"storageProfile\" : {\r\n \"imageReference\":{\r\n \"publisher\":\"\",\r\n \"offer\":\"\",\r\n \"sku\":\"\",\r\n \"version\":\"\"\r\n },\r\n \"osDisk\":{\r\n \"name\":\"\",\r\n \"caching\":null,\r\n \"createOption\":\"\",\r\n \"osType\":null,\r\n \"image\":{\r\n \"uri\":\"\"\r\n },\r\n \"vhdContainers\":[\r\n \"\"\r\n ]\r\n }\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config storage-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--image-reference", "required": 0, "optional": 0, "bool": true, "long": "--image-reference", "description": "Remove the image-reference value." }, { "flags": "--os-disk", "required": 0, "optional": 0, "bool": true, "long": "--os-disk", "description": "Remove the os-disk value." } ] } ], "categories": {} }, "image-reference": { "name": "image-reference", "description": "Commands to configure image-reference of vmss in config file.", "fullName": "vmss config image-reference", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set image-reference in config string or files, e.g. \r\n {\r\n ...\r\n \"imageReference\" : {\r\n \"publisher\":\"\",\r\n \"offer\":\"\",\r\n \"sku\":\"\",\r\n \"version\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config image-reference set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--publisher ", "required": -13, "optional": 0, "bool": true, "long": "--publisher", "description": "Set the publisher value." }, { "flags": "--offer ", "required": -9, "optional": 0, "bool": true, "long": "--offer", "description": "Set the offer value." }, { "flags": "--sku ", "required": -7, "optional": 0, "bool": true, "long": "--sku", "description": "Set the sku value." }, { "flags": "--version ", "required": -11, "optional": 0, "bool": true, "long": "--version", "description": "Set the version value." } ] }, { "name": "delete", "description": "Remove image-reference in config string or files, e.g. \r\n {\r\n ...\r\n \"imageReference\" : {\r\n \"publisher\":\"\",\r\n \"offer\":\"\",\r\n \"sku\":\"\",\r\n \"version\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config image-reference delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--publisher", "required": 0, "optional": 0, "bool": true, "long": "--publisher", "description": "Remove the publisher value." }, { "flags": "--offer", "required": 0, "optional": 0, "bool": true, "long": "--offer", "description": "Remove the offer value." }, { "flags": "--sku", "required": 0, "optional": 0, "bool": true, "long": "--sku", "description": "Remove the sku value." }, { "flags": "--version", "required": 0, "optional": 0, "bool": true, "long": "--version", "description": "Remove the version value." } ] } ], "categories": {} }, "os-disk": { "name": "os-disk", "description": "Commands to configure os-disk of vmss in config file.", "fullName": "vmss config os-disk", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set os-disk in config string or files, e.g. \r\n {\r\n ...\r\n \"osDisk\" : {\r\n \"name\":\"\",\r\n \"caching\":null,\r\n \"createOption\":\"\",\r\n \"osType\":null,\r\n \"image\":{\r\n \"uri\":\"\"\r\n },\r\n \"vhdContainers\":[\r\n \"\"\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config os-disk set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "Set the name value." }, { "flags": "--caching ", "required": -11, "optional": 0, "bool": true, "long": "--caching", "description": "Set the caching value." }, { "flags": "--create-option ", "required": -17, "optional": 0, "bool": true, "long": "--create-option", "description": "Set the create-option value." }, { "flags": "--os-type ", "required": -11, "optional": 0, "bool": true, "long": "--os-type", "description": "Set the os-type value." }, { "flags": "--image ", "required": -9, "optional": 0, "bool": true, "long": "--image", "description": "Set the image value." }, { "flags": "--vhd-containers ", "required": -18, "optional": 0, "bool": true, "long": "--vhd-containers", "description": "Set the vhd-containers value." } ] }, { "name": "delete", "description": "Remove os-disk in config string or files, e.g. \r\n {\r\n ...\r\n \"osDisk\" : {\r\n \"name\":\"\",\r\n \"caching\":null,\r\n \"createOption\":\"\",\r\n \"osType\":null,\r\n \"image\":{\r\n \"uri\":\"\"\r\n },\r\n \"vhdContainers\":[\r\n \"\"\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config os-disk delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--name", "required": 0, "optional": 0, "bool": true, "long": "--name", "description": "Remove the name value." }, { "flags": "--caching", "required": 0, "optional": 0, "bool": true, "long": "--caching", "description": "Remove the caching value." }, { "flags": "--create-option", "required": 0, "optional": 0, "bool": true, "long": "--create-option", "description": "Remove the create-option value." }, { "flags": "--os-type", "required": 0, "optional": 0, "bool": true, "long": "--os-type", "description": "Remove the os-type value." }, { "flags": "--image", "required": 0, "optional": 0, "bool": true, "long": "--image", "description": "Remove the image value." }, { "flags": "--vhd-containers", "required": 0, "optional": 0, "bool": true, "long": "--vhd-containers", "description": "Remove the vhd-containers value." } ] } ], "categories": {} }, "image": { "name": "image", "description": "Commands to configure image of vmss in config file.", "fullName": "vmss config image", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set image in config string or files, e.g. \r\n {\r\n ...\r\n \"image\" : {\r\n \"uri\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config image set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--uri ", "required": -7, "optional": 0, "bool": true, "long": "--uri", "description": "Set the uri value." } ] }, { "name": "delete", "description": "Remove image in config string or files, e.g. \r\n {\r\n ...\r\n \"image\" : {\r\n \"uri\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config image delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--uri", "required": 0, "optional": 0, "bool": true, "long": "--uri", "description": "Remove the uri value." } ] } ], "categories": {} }, "vhd-containers": { "name": "vhd-containers", "description": "Commands to configure vhd-containers of vmss in config file.", "fullName": "vmss config vhd-containers", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set vhd-containers in config string or files, e.g. \r\n {\r\n ...\r\n \"vhdContainers\" : \"\"\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config vhd-containers set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." } ] }, { "name": "delete", "description": "Remove vhd-containers in config string or files, e.g. \r\n {\r\n ...\r\n \"vhdContainers\" : \"\"\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config vhd-containers delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." } ] } ], "categories": {} }, "network-profile": { "name": "network-profile", "description": "Commands to configure network-profile of vmss in config file.", "fullName": "vmss config network-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set network-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"networkProfile\" : {\r\n \"networkInterfaceConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"primary\":null,\r\n \"ipConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config network-profile set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--network-interface-configurations ", "required": -36, "optional": 0, "bool": true, "long": "--network-interface-configurations", "description": "Set the network-interface-configurations value." } ] }, { "name": "delete", "description": "Remove network-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"networkProfile\" : {\r\n \"networkInterfaceConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"primary\":null,\r\n \"ipConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config network-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--network-interface-configurations", "required": 0, "optional": 0, "bool": true, "long": "--network-interface-configurations", "description": "Remove the network-interface-configurations value." } ] } ], "categories": {} }, "network-interface-configurations": { "name": "network-interface-configurations", "description": "Commands to configure network-interface-configurations of vmss in config file.", "fullName": "vmss config network-interface-configurations", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set network-interface-configurations in config string or files, e.g. \r\n {\r\n ...\r\n \"networkInterfaceConfigurations\" : {\r\n \"name\":\"\",\r\n \"primary\":null,\r\n \"ipConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config network-interface-configurations set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "Set the name value." }, { "flags": "--primary ", "required": -11, "optional": 0, "bool": true, "long": "--primary", "description": "Set the primary value." }, { "flags": "--ip-configurations ", "required": -21, "optional": 0, "bool": true, "long": "--ip-configurations", "description": "Set the ip-configurations value." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove network-interface-configurations in config string or files, e.g. \r\n {\r\n ...\r\n \"networkInterfaceConfigurations\" : {\r\n \"name\":\"\",\r\n \"primary\":null,\r\n \"ipConfigurations\":[\r\n {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config network-interface-configurations delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--name", "required": 0, "optional": 0, "bool": true, "long": "--name", "description": "Remove the name value." }, { "flags": "--primary", "required": 0, "optional": 0, "bool": true, "long": "--primary", "description": "Remove the primary value." }, { "flags": "--ip-configurations", "required": 0, "optional": 0, "bool": true, "long": "--ip-configurations", "description": "Remove the ip-configurations value." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} }, "ip-configurations": { "name": "ip-configurations", "description": "Commands to configure ip-configurations of vmss in config file.", "fullName": "vmss config ip-configurations", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set ip-configurations in config string or files, e.g. \r\n {\r\n ...\r\n \"ipConfigurations\" : {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config ip-configurations set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "Set the name value." }, { "flags": "--subnet ", "required": -10, "optional": 0, "bool": true, "long": "--subnet", "description": "Set the subnet value." }, { "flags": "--application-gateway-backend-address-pools ", "required": -45, "optional": 0, "bool": true, "long": "--application-gateway-backend-address-pools", "description": "Set the application-gateway-backend-address-pools value." }, { "flags": "--load-balancer-backend-address-pools ", "required": -39, "optional": 0, "bool": true, "long": "--load-balancer-backend-address-pools", "description": "Set the load-balancer-backend-address-pools value." }, { "flags": "--load-balancer-inbound-nat-pools ", "required": -35, "optional": 0, "bool": true, "long": "--load-balancer-inbound-nat-pools", "description": "Set the load-balancer-inbound-nat-pools value." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove ip-configurations in config string or files, e.g. \r\n {\r\n ...\r\n \"ipConfigurations\" : {\r\n \"name\":\"\",\r\n \"subnet\":{\r\n \"id\":\"\"\r\n },\r\n \"applicationGatewayBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerBackendAddressPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"loadBalancerInboundNatPools\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config ip-configurations delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--name", "required": 0, "optional": 0, "bool": true, "long": "--name", "description": "Remove the name value." }, { "flags": "--subnet", "required": 0, "optional": 0, "bool": true, "long": "--subnet", "description": "Remove the subnet value." }, { "flags": "--application-gateway-backend-address-pools", "required": 0, "optional": 0, "bool": true, "long": "--application-gateway-backend-address-pools", "description": "Remove the application-gateway-backend-address-pools value." }, { "flags": "--load-balancer-backend-address-pools", "required": 0, "optional": 0, "bool": true, "long": "--load-balancer-backend-address-pools", "description": "Remove the load-balancer-backend-address-pools value." }, { "flags": "--load-balancer-inbound-nat-pools", "required": 0, "optional": 0, "bool": true, "long": "--load-balancer-inbound-nat-pools", "description": "Remove the load-balancer-inbound-nat-pools value." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} }, "subnet": { "name": "subnet", "description": "Commands to configure subnet of vmss in config file.", "fullName": "vmss config subnet", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set subnet in config string or files, e.g. \r\n {\r\n ...\r\n \"subnet\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config subnet set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--ip-configurations-index ", "required": -27, "optional": 0, "bool": true, "long": "--ip-configurations-index", "description": "Indexer: ip-configurations-index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove subnet in config string or files, e.g. \r\n {\r\n ...\r\n \"subnet\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config subnet delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--ip-configurations-index ", "required": -27, "optional": 0, "bool": true, "long": "--ip-configurations-index", "description": "Indexer: ip-configurations-index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} }, "application-gateway-backend-address-pools": { "name": "application-gateway-backend-address-pools", "description": "Commands to configure application-gateway-backend-address-pools of vmss in config file.", "fullName": "vmss config application-gateway-backend-address-pools", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set application-gateway-backend-address-pools in config string or files, e.g. \r\n {\r\n ...\r\n \"applicationGatewayBackendAddressPools\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config application-gateway-backend-address-pools set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--ip-configurations-index ", "required": -27, "optional": 0, "bool": true, "long": "--ip-configurations-index", "description": "Indexer: ip-configurations-index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove application-gateway-backend-address-pools in config string or files, e.g. \r\n {\r\n ...\r\n \"applicationGatewayBackendAddressPools\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config application-gateway-backend-address-pools delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--ip-configurations-index ", "required": -27, "optional": 0, "bool": true, "long": "--ip-configurations-index", "description": "Indexer: ip-configurations-index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} }, "load-balancer-backend-address-pools": { "name": "load-balancer-backend-address-pools", "description": "Commands to configure load-balancer-backend-address-pools of vmss in config file.", "fullName": "vmss config load-balancer-backend-address-pools", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set load-balancer-backend-address-pools in config string or files, e.g. \r\n {\r\n ...\r\n \"loadBalancerBackendAddressPools\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config load-balancer-backend-address-pools set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--ip-configurations-index ", "required": -27, "optional": 0, "bool": true, "long": "--ip-configurations-index", "description": "Indexer: ip-configurations-index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove load-balancer-backend-address-pools in config string or files, e.g. \r\n {\r\n ...\r\n \"loadBalancerBackendAddressPools\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config load-balancer-backend-address-pools delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--ip-configurations-index ", "required": -27, "optional": 0, "bool": true, "long": "--ip-configurations-index", "description": "Indexer: ip-configurations-index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} }, "load-balancer-inbound-nat-pools": { "name": "load-balancer-inbound-nat-pools", "description": "Commands to configure load-balancer-inbound-nat-pools of vmss in config file.", "fullName": "vmss config load-balancer-inbound-nat-pools", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set load-balancer-inbound-nat-pools in config string or files, e.g. \r\n {\r\n ...\r\n \"loadBalancerInboundNatPools\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config load-balancer-inbound-nat-pools set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--ip-configurations-index ", "required": -27, "optional": 0, "bool": true, "long": "--ip-configurations-index", "description": "Indexer: ip-configurations-index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove load-balancer-inbound-nat-pools in config string or files, e.g. \r\n {\r\n ...\r\n \"loadBalancerInboundNatPools\" : {\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config load-balancer-inbound-nat-pools delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--ip-configurations-index ", "required": -27, "optional": 0, "bool": true, "long": "--ip-configurations-index", "description": "Indexer: ip-configurations-index." }, { "flags": "--network-interface-configurations-index ", "required": -42, "optional": 0, "bool": true, "long": "--network-interface-configurations-index", "description": "Indexer: network-interface-configurations-index." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} }, "extension-profile": { "name": "extension-profile", "description": "Commands to configure extension-profile of vmss in config file.", "fullName": "vmss config extension-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set extension-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"extensionProfile\" : {\r\n \"extensions\":[\r\n {\r\n \"name\":\"\",\r\n \"publisher\":\"\",\r\n \"type\":\"\",\r\n \"typeHandlerVersion\":\"\",\r\n \"autoUpgradeMinorVersion\":null,\r\n \"settings\":{\r\n },\r\n \"protectedSettings\":{\r\n },\r\n \"provisioningState\":\"\",\r\n \"id\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config extension-profile set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--extensions ", "required": -14, "optional": 0, "bool": true, "long": "--extensions", "description": "Set the extensions value." } ] }, { "name": "delete", "description": "Remove extension-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"extensionProfile\" : {\r\n \"extensions\":[\r\n {\r\n \"name\":\"\",\r\n \"publisher\":\"\",\r\n \"type\":\"\",\r\n \"typeHandlerVersion\":\"\",\r\n \"autoUpgradeMinorVersion\":null,\r\n \"settings\":{\r\n },\r\n \"protectedSettings\":{\r\n },\r\n \"provisioningState\":\"\",\r\n \"id\":\"\"\r\n }\r\n ]\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config extension-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--extensions", "required": 0, "optional": 0, "bool": true, "long": "--extensions", "description": "Remove the extensions value." } ] } ], "categories": {} }, "extensions": { "name": "extensions", "description": "Commands to configure extensions of vmss in config file.", "fullName": "vmss config extensions", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set extensions in config string or files, e.g. \r\n {\r\n ...\r\n \"extensions\" : {\r\n \"name\":\"\",\r\n \"publisher\":\"\",\r\n \"type\":\"\",\r\n \"typeHandlerVersion\":\"\",\r\n \"autoUpgradeMinorVersion\":null,\r\n \"settings\":{\r\n },\r\n \"protectedSettings\":{\r\n },\r\n \"provisioningState\":\"\",\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config extensions set", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--value ", "required": -9, "optional": 0, "bool": true, "long": "--value", "description": "The input string value for the indexed item." }, { "flags": "--parse", "required": 0, "optional": 0, "bool": true, "long": "--parse", "description": "Parse the input string, i.e. str, for parameters to a JSON object, e.g. JSON.parse(str)." }, { "flags": "--name ", "required": -8, "optional": 0, "bool": true, "long": "--name", "description": "Set the name value." }, { "flags": "--publisher ", "required": -13, "optional": 0, "bool": true, "long": "--publisher", "description": "Set the publisher value." }, { "flags": "--type ", "required": -8, "optional": 0, "bool": true, "long": "--type", "description": "Set the type value." }, { "flags": "--type-handler-version ", "required": -24, "optional": 0, "bool": true, "long": "--type-handler-version", "description": "Set the type-handler-version value." }, { "flags": "--auto-upgrade-minor-version ", "required": -30, "optional": 0, "bool": true, "long": "--auto-upgrade-minor-version", "description": "Set the auto-upgrade-minor-version value." }, { "flags": "--settings ", "required": -12, "optional": 0, "bool": true, "long": "--settings", "description": "Set the settings value." }, { "flags": "--protected-settings ", "required": -22, "optional": 0, "bool": true, "long": "--protected-settings", "description": "Set the protected-settings value." }, { "flags": "--provisioning-state ", "required": -22, "optional": 0, "bool": true, "long": "--provisioning-state", "description": "Set the provisioning-state value." }, { "flags": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove extensions in config string or files, e.g. \r\n {\r\n ...\r\n \"extensions\" : {\r\n \"name\":\"\",\r\n \"publisher\":\"\",\r\n \"type\":\"\",\r\n \"typeHandlerVersion\":\"\",\r\n \"autoUpgradeMinorVersion\":null,\r\n \"settings\":{\r\n },\r\n \"protectedSettings\":{\r\n },\r\n \"provisioningState\":\"\",\r\n \"id\":\"\"\r\n }\r\n ...\r\n }\r\n\r\n There are two sets of commands:\r\n 1) function commands that are used to manage Azure resources in the cloud, and \r\n 2) parameter commands that generate & edit input files for the other set of commands.\r\n For example, 'vmss show/list/stop' are the function commands that call get, list and stop operations of \r\n virtual machine scale set, whereas 'vmss config * generate/create/set/delete/add' commands \r\n are used to configure the input parameter file. The 'vmss config' command takes a parameter \r\n file as for the VM scale set configuration, and creates it online.", "fullName": "vmss config extensions delete", "usage": "[options]", "filePath": "commands/arm/compute/virtualMachineScaleSets.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--index ", "required": -9, "optional": 0, "bool": true, "long": "--index", "description": "Indexer: index." }, { "flags": "--name", "required": 0, "optional": 0, "bool": true, "long": "--name", "description": "Remove the name value." }, { "flags": "--publisher", "required": 0, "optional": 0, "bool": true, "long": "--publisher", "description": "Remove the publisher value." }, { "flags": "--type", "required": 0, "optional": 0, "bool": true, "long": "--type", "description": "Remove the type value." }, { "flags": "--type-handler-version", "required": 0, "optional": 0, "bool": true, "long": "--type-handler-version", "description": "Remove the type-handler-version value." }, { "flags": "--auto-upgrade-minor-version", "required": 0, "optional": 0, "bool": true, "long": "--auto-upgrade-minor-version", "description": "Remove the auto-upgrade-minor-version value." }, { "flags": "--settings", "required": 0, "optional": 0, "bool": true, "long": "--settings", "description": "Remove the settings value." }, { "flags": "--protected-settings", "required": 0, "optional": 0, "bool": true, "long": "--protected-settings", "description": "Remove the protected-settings value." }, { "flags": "--provisioning-state", "required": 0, "optional": 0, "bool": true, "long": "--provisioning-state", "description": "Remove the provisioning-state value." }, { "flags": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} } } } } }, "vm": { "name": "vm", "description": "Commands to manage your virtual machines", "fullName": "vm", "usage": "[options] [command]", "options": [], "commands": [ { "name": "redeploy", "description": "The operation to redeploy a virtual machine.", "fullName": "vm redeploy", "usage": "[options] ", "filePath": "commands/arm/compute/virtualMachines.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "resource-group" }, { "flags": "-n, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-n", "long": "--vm-name", "description": "vm-name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "The subscription identifier" } ] }, { "name": "create", "description": "Create a virtual machine in a resource group", "fullName": "vm create", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-D, --nic-id ", "required": -14, "optional": 0, "bool": true, "short": "-D", "long": "--nic-id", "description": "the NIC identifier\n e.g. /subscriptions//resourceGroups//providers/Microsoft.Network/networkInterfaces/" }, { "flags": "-f, --nic-name ", "required": -16, "optional": 0, "bool": true, "short": "-f", "long": "--nic-name", "description": "the NIC name\n If this is an existing NIC then it must exists under the current resource group identified by resource-group\n A new NIC will be created if no NIC exists with name nic-name in the current resource group\n To create new NIC - subnet-id or vnet-name, vnet-address-prefix, subnet-name and vnet-subnet-address-prefix are required\n Please use nic-id to refer an existing NIC in a different resource group\n The parameter nic-name will be ignored when nic-id is specified" }, { "flags": "-I, --nic-ids ", "required": -15, "optional": 0, "bool": true, "short": "-I", "long": "--nic-ids", "description": "the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary." }, { "flags": "-N, --nic-names ", "required": -17, "optional": 0, "bool": true, "short": "-N", "long": "--nic-names", "description": "the list of NIC names separated by comma. In case of specifying multiple nics first one will be set as primary.These NICs must exists in the same resource group as the VM. Please use nic-ids if that not the case. This parameter will be ignored if --nic-ids is specified" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-y, --os-type ", "required": -15, "optional": 0, "bool": true, "short": "-y", "long": "--os-type", "description": "the operating system Type, valid values are Windows, Linux" }, { "flags": "-Q, --image-urn ", "required": -17, "optional": 0, "bool": true, "short": "-Q", "long": "--image-urn", "description": "the image URN in the form publisherName:offer:skus:version.\n URN Aliases:\n Win2012R2Datacenter = MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter:latest\n Win2012Datacenter = MicrosoftWindowsServer:WindowsServer:2012-Datacenter:latest\n Win2008R2SP1 = MicrosoftWindowsServer:WindowsServer:2008-R2-SP1:latest\n CentOS = OpenLogic:CentOS:7.2:latest\n CoreOS = CoreOS:CoreOS:Stable:latest\n Debian = credativ:Debian:8:latest\n openSUSE = SUSE:openSUSE:13.2:latest\n RHEL = RedHat:RHEL:7.2:latest\n SLES = SUSE:SLES:12-SP1:latest\n UbuntuLTS = Canonical:UbuntuServer:14.04.4-LTS:latest\n\n Or the source VHD link of a user image, e.g. https://foo.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/snap-bar.vhd\n Option '-d' can be used with this option to specify the destination storage location where the new OS VHD will be created and put to.\n In this case, OS profile credentials have to be specified, i.e. user name/password, or SSH keys, etc." }, { "flags": "-u, --admin-username ", "required": -22, "optional": 0, "bool": true, "short": "-u", "long": "--admin-username", "description": "the user name\n This parameter is valid for a VM created from an image (image-urn) and ignored when VM is based on an existing disk" }, { "flags": "-p, --admin-password ", "required": -22, "optional": 0, "bool": true, "short": "-p", "long": "--admin-password", "description": "the password\n This parameter is valid for a VM created from an image (image-urn) and ignored when VM is based on existing disk" }, { "flags": "-M, --ssh-publickey-file ", "required": -26, "optional": 0, "bool": true, "short": "-M", "long": "--ssh-publickey-file", "description": "path to public key PEM file or SSH Public key file for SSH authentication\n This parameter is valid only when os-type is \"Linux\"" }, { "flags": "-G, --generate-ssh-keys", "required": 0, "optional": 0, "bool": true, "short": "-G", "long": "--generate-ssh-keys", "description": "Auto generate SSH keys, will be ignored if --ssh-publickey-file is specified. This parameter is valid only when os-type is \"Linux\"" }, { "flags": "-z, --vm-size ", "required": -15, "optional": 0, "bool": true, "short": "-z", "long": "--vm-size", "description": "the virtual machine size [Standard_DS1]" }, { "flags": "-U, --public-ip-id ", "required": -20, "optional": 0, "bool": true, "short": "-U", "long": "--public-ip-id", "description": "the public ip identifier\n e.g. /subscriptions//resourceGroups//providers/Microsoft.Network/publicIPAddresses/" }, { "flags": "-i, --public-ip-name ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--public-ip-name", "description": "the public ip name\n If this is an existing public IP then it must exists under the current resource group identified by resource-group\n A new public IP will be created if no public IP exists with name public-ip-name in the current resource group\n Please use public-ip-id to refer an existing public IP in a different resource group\n The parameter public-ip-name will be ignored when public-ip-id is specified" }, { "flags": "-w, --public-ip-domain-name ", "required": -29, "optional": 0, "bool": true, "short": "-w", "long": "--public-ip-domain-name", "description": "the public ip domain name\n This sets the DNS to ..cloudapp.azure.com\n This parameter will be used only when creating new public IP" }, { "flags": "-m, --public-ip-allocation-method ", "required": -35, "optional": 0, "bool": true, "short": "-m", "long": "--public-ip-allocation-method", "description": "the public ip allocation method, valid values are \"Dynamic\"\n This parameter will be used only when creating new public IP" }, { "flags": "-t, --public-ip-idletimeout ", "required": -29, "optional": 0, "bool": true, "short": "-t", "long": "--public-ip-idletimeout", "description": "the public ip idle timeout specified in minutes\n This parameter will be used only when creating new public IP" }, { "flags": "-S, --subnet-id ", "required": -17, "optional": 0, "bool": true, "short": "-S", "long": "--subnet-id", "description": "the subnet identifier\n e.g. /subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/" }, { "flags": "-F, --vnet-name ", "required": -17, "optional": 0, "bool": true, "short": "-F", "long": "--vnet-name", "description": "the virtual network name\n If this is an existing vnet then it must exists under the current resource group identified by resource-group\n If this is an existing vnet then vnet-subnet-name is required\n If no subnet exists with name vnet-subnet-name then a new subnet will be created\n To create new subnet - vnet-subnet-address-prefix is required\n A new vnet will be created if no vnet exists with name vnet-name in the current resource group\n To create new vnet - vnet-address-prefix, vnet-subnet-name and vnet-subnet-address-prefix are required\n Please use subnet-id to refer an existing subnet under a vnet in a different resource group\n vnet-name, vnet-address-prefix, vnet-subnet-name and vnet-subnet-address-prefix will be ignored when subnet-id is specified" }, { "flags": "-P, --vnet-address-prefix ", "required": -27, "optional": 0, "bool": true, "short": "-P", "long": "--vnet-address-prefix", "description": "the virtual network address prefix in IPv4/CIDR format" }, { "flags": "-j, --vnet-subnet-name ", "required": -24, "optional": 0, "bool": true, "short": "-j", "long": "--vnet-subnet-name", "description": "the virtual network subnet name" }, { "flags": "-k, --vnet-subnet-address-prefix ", "required": -34, "optional": 0, "bool": true, "short": "-k", "long": "--vnet-subnet-address-prefix", "description": "the virtual network subnet address prefix in IPv4/CIDR format" }, { "flags": "-r, --availset-name ", "required": -21, "optional": 0, "bool": true, "short": "-r", "long": "--availset-name", "description": "the availability set name" }, { "flags": "-o, --storage-account-name ", "required": -28, "optional": 0, "bool": true, "short": "-o", "long": "--storage-account-name", "description": "the storage account name" }, { "flags": "--storage-account-type ", "required": -24, "optional": 0, "bool": true, "long": "--storage-account-type", "description": "the storage account type for to-be-generated storage account, default Premium_LRS" }, { "flags": "-R, --storage-account-container-name ", "required": -38, "optional": 0, "bool": true, "short": "-R", "long": "--storage-account-container-name", "description": "the storage account container name [vhds]" }, { "flags": "-d, --os-disk-vhd ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--os-disk-vhd", "description": "name or url of the OS disk Vhd\n If this parameter is specified along with --image-urn ('-Q') parameter then OS disk created from the image will be stored in this vhd.\n If this parameter is specified without --image-urn ('-Q') parameter then this vhd must exists and will be used as a specialized OS disk image.\n If this parameter is specified without --image-urn ('-Q') parameter, OS profile credentials will be ignored, and the specialized credentials from the disk image will be used." }, { "flags": "-a, --data-disk-caching ", "required": -25, "optional": 0, "bool": true, "short": "-a", "long": "--data-disk-caching", "description": "data disk caching, valid values are None, ReadOnly, ReadWrite" }, { "flags": "-x, --data-disk-vhd ", "required": -21, "optional": 0, "bool": true, "short": "-x", "long": "--data-disk-vhd", "description": "name or url of the data disk Vhd" }, { "flags": "-e, --data-disk-size ", "required": -22, "optional": 0, "bool": true, "short": "-e", "long": "--data-disk-size", "description": "data disk size in GB" }, { "flags": "-Y, --data-disk-existing", "required": 0, "optional": 0, "bool": true, "short": "-Y", "long": "--data-disk-existing", "description": "Will use existing VHD if specified. Don't specify this param if you are creating data disk from a new VHD." }, { "flags": "-C, --custom-data ", "required": -19, "optional": 0, "bool": true, "short": "-C", "long": "--custom-data", "description": "CustomData file" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" }, { "flags": "--tags ", "required": -8, "optional": 0, "bool": true, "long": "--tags", "description": "Tags to set to the virtual machine. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, --tags tag1=value1;tag2" }, { "flags": "--disable-boot-diagnostics", "required": 0, "optional": 0, "bool": true, "long": "--disable-boot-diagnostics", "description": "The switch parameter to disable the boot diagnostics (by default enabled) for VM." }, { "flags": "--boot-diagnostics-storage-uri ", "required": -32, "optional": 0, "bool": true, "long": "--boot-diagnostics-storage-uri", "description": "Optional. Specify storage account URL for boot diagnostics. In the format of 'https://your_stoage_account_name.blob.core.windows.net/'." }, { "flags": "--disable-bginfo-extension", "required": 0, "optional": 0, "bool": true, "long": "--disable-bginfo-extension", "description": "The switch parameter to disable the BGInfo extension for VM." }, { "flags": "--disk-encryption-key-vault-id ", "required": -32, "optional": 0, "bool": true, "long": "--disk-encryption-key-vault-id", "description": "The OS disk encryption key vault ID." }, { "flags": "--disk-encryption-key-url ", "required": -27, "optional": 0, "bool": true, "long": "--disk-encryption-key-url", "description": "The OS disk encryption key secret URL." }, { "flags": "--key-encryption-key-vault-id ", "required": -31, "optional": 0, "bool": true, "long": "--key-encryption-key-vault-id", "description": "The vault reference Url for the OS disk encryption key." }, { "flags": "--key-encryption-key-url ", "required": -26, "optional": 0, "bool": true, "long": "--key-encryption-key-url", "description": "The Url of the master key used to encrypt the OS disk encryption key." }, { "flags": "--license-type ", "required": -16, "optional": 0, "bool": true, "long": "--license-type", "description": "The license type of the system; currently, only 'Windows_Sever' is supported." }, { "flags": "--plan-name ", "required": -13, "optional": 0, "bool": true, "long": "--plan-name", "description": "The plan name." }, { "flags": "--plan-publisher ", "required": -18, "optional": 0, "bool": true, "long": "--plan-publisher", "description": "The plan publisher ID." }, { "flags": "--plan-product ", "required": -16, "optional": 0, "bool": true, "long": "--plan-product", "description": "The plan product ID." }, { "flags": "--plan-promotion-code ", "required": -23, "optional": 0, "bool": true, "long": "--plan-promotion-code", "description": "The plan promotion code." } ] }, { "name": "quick-create", "description": "Create a virtual machine with default resources in a resource group", "fullName": "vm quick-create", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-y, --os-type ", "required": -15, "optional": 0, "bool": true, "short": "-y", "long": "--os-type", "description": "the operating system Type, valid values are Windows, Linux" }, { "flags": "-Q, --image-urn ", "required": -17, "optional": 0, "bool": true, "short": "-Q", "long": "--image-urn", "description": "the image URN in the form \"publisherName:offer:skus:version\",\n URN Aliases:\n Win2012R2Datacenter = MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter:latest\n Win2012Datacenter = MicrosoftWindowsServer:WindowsServer:2012-Datacenter:latest\n Win2008R2SP1 = MicrosoftWindowsServer:WindowsServer:2008-R2-SP1:latest\n CentOS = OpenLogic:CentOS:7.2:latest\n CoreOS = CoreOS:CoreOS:Stable:latest\n Debian = credativ:Debian:8:latest\n openSUSE = SUSE:openSUSE:13.2:latest\n RHEL = RedHat:RHEL:7.2:latest\n SLES = SUSE:SLES:12-SP1:latest\n UbuntuLTS = Canonical:UbuntuServer:14.04.4-LTS:latest\n or the VHD link of a user image,\n e.g. https://foo.blob.core.windows.net/bar/vhds/baz.vhd" }, { "flags": "-z, --vm-size ", "required": -15, "optional": 0, "bool": true, "short": "-z", "long": "--vm-size", "description": "the virtual machine size [Standard_DS1]" }, { "flags": "-u, --admin-username ", "required": -22, "optional": 0, "bool": true, "short": "-u", "long": "--admin-username", "description": "the user name" }, { "flags": "-p, --admin-password ", "required": -22, "optional": 0, "bool": true, "short": "-p", "long": "--admin-password", "description": "the password, skipped if SSH public key file is specified for Linux VMs" }, { "flags": "-M, --ssh-publickey-file ", "required": -26, "optional": 0, "bool": true, "short": "-M", "long": "--ssh-publickey-file", "description": "the path to public key file for SSH authentication,\n & this parameter is valid only when os-type is Linux." }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list", "description": "Get all virtual machines in a resource group", "fullName": "vm list", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list-ip-address", "description": "Get all virtual machines and their corresponding IP addresses in subscription. If a resource group is specified it will list virtual machines and their corresponding IP addresses in specified resource group.", "fullName": "vm list-ip-address", "usage": "[options] [resource-group]", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "show", "description": "Get a virtual machine in a resource group", "fullName": "vm show", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-d, --depth ", "required": -13, "optional": 0, "bool": true, "short": "-d", "long": "--depth", "description": "the number of times to recurse, to recurse indefinitely pass \"full\". (valid only with --json option)" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "delete", "description": "Delete a virtual machine in a resource group", "fullName": "vm delete", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for delete confirmation" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "stop", "description": "Shutdown a virtual machine in a resource group", "fullName": "vm stop", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "restart", "description": "Restart a virtual machine in a resource group", "fullName": "vm restart", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "start", "description": "Start a virtual machine in a resource group", "fullName": "vm start", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "deallocate", "description": "Shutdown a virtual machine in a resource group and release the compute resources", "fullName": "vm deallocate", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "sizes", "description": "Get all available virtual machine sizes", "fullName": "vm sizes", "usage": "[options]", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location name, use this to get the list of VM sizes available in a location" }, { "flags": "-n, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-n", "long": "--vm-name", "description": "the virtual machine name, use this to get the list of VM sizes available for a specific VM" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name, required when --vm-name is specified" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "capture", "description": "Capture a VM in a resource group as an OS Image or VM Image", "fullName": "vm capture", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-p, --vhd-name-prefix ", "required": -23, "optional": 0, "bool": true, "short": "-p", "long": "--vhd-name-prefix", "description": "Captured virtual hard disk's name prefix" }, { "flags": "-R, --storage-account-container-name ", "required": -38, "optional": 0, "bool": true, "short": "-R", "long": "--storage-account-container-name", "description": "the storage account container name [vhds]" }, { "flags": "-o, --overwrite", "required": 0, "optional": 0, "bool": true, "short": "-o", "long": "--overwrite", "description": "In case of conflict overwrite the target virtual hard disk if set to true." }, { "flags": "-t, --template-file-name ", "required": -26, "optional": 0, "bool": true, "short": "-t", "long": "--template-file-name", "description": "Name of the file that will contain a template that can be used to create similar VMs." }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "generalize", "description": "Set the state of a VM in a resource group to Generalized.", "fullName": "vm generalize", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "get-instance-view", "description": "Get instance view of a VM in a resource group.", "fullName": "vm get-instance-view", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "get-serial-output", "description": "Get serial output of a VM in a resource group.", "fullName": "vm get-serial-output", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" }, { "flags": "--max-length ", "required": -14, "optional": 0, "bool": true, "long": "--max-length", "description": "the max number of characters shown in one page of log output" } ] }, { "name": "reset-access", "description": "Enables you to reset Remote Desktop Access or SSH settings on a Virtual Machine and to reset the password for the account that has administrator or sudo authority.", "fullName": "vm reset-access", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-u, --user-name ", "required": -17, "optional": 0, "bool": true, "short": "-u", "long": "--user-name", "description": "the user name" }, { "flags": "-p, --password ", "required": -16, "optional": 0, "bool": true, "short": "-p", "long": "--password", "description": "the password" }, { "flags": "-M, --ssh-key-file ", "required": -20, "optional": 0, "bool": true, "short": "-M", "long": "--ssh-key-file", "description": "path to public key PEM file or SSH Public key file for SSH authentication (valid only when os-type is \"Linux\")" }, { "flags": "-r, --reset-ssh", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--reset-ssh", "description": "Reset the SSH configuration to default" }, { "flags": "-E, --extension-version ", "required": -25, "optional": 0, "bool": true, "short": "-E", "long": "--extension-version", "description": "Version of VM Access extension [1.4]" }, { "flags": "-e, --expiration ", "required": -18, "optional": 0, "bool": true, "short": "-e", "long": "--expiration", "description": "password expiration" }, { "flags": "-R, --remove-user ", "required": -19, "optional": 0, "bool": true, "short": "-R", "long": "--remove-user", "description": "Remove a user account with specified name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "enable-aem", "description": "Enable Azure Enhanced Monitoring Extension on a VM in a resource group", "fullName": "vm enable-aem", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-a, --diagnostic-storage-account-name ", "required": -39, "optional": 0, "bool": true, "short": "-a", "long": "--diagnostic-storage-account-name", "description": "storage account name" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quite mode(do not ask for confirmation)" } ] }, { "name": "set", "description": "Update a VM in a resource group.", "fullName": "vm set", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-I, --nic-ids ", "required": -15, "optional": 0, "bool": true, "short": "-I", "long": "--nic-ids", "description": "the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary." }, { "flags": "-N, --nic-names ", "required": -17, "optional": 0, "bool": true, "short": "-N", "long": "--nic-names", "description": "the list of NIC names separated by comma. In case of specifying multiple nics first one will be set as primary.These NICs must exists in the same resource group as the VM. Please use nic-ids if that not the case. This parameter will be ignored if --nic-ids is specified" }, { "flags": "-z, --vm-size ", "required": -15, "optional": 0, "bool": true, "short": "-z", "long": "--vm-size", "description": "the virtual machine size" }, { "flags": "-t, --tags ", "required": -12, "optional": 0, "bool": true, "short": "-t", "long": "--tags", "description": "Tags to set to the resource group. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2" }, { "flags": "-T, --no-tags", "required": 0, "optional": 0, "bool": false, "short": "-T", "long": "--no-tags", "description": "Remove all tags" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" }, { "flags": "--disable-boot-diagnostics", "required": 0, "optional": 0, "bool": true, "long": "--disable-boot-diagnostics", "description": "The switch parameter to disable the boot diagnostics for VM." }, { "flags": "--enable-boot-diagnostics", "required": 0, "optional": 0, "bool": true, "long": "--enable-boot-diagnostics", "description": "The switch parameter to enable the boot diagnostics for VM." }, { "flags": "--boot-diagnostics-storage-uri ", "required": -32, "optional": 0, "bool": true, "long": "--boot-diagnostics-storage-uri", "description": "The storage account URL for boot diagnostics. In the format of 'https://your_stoage_account_name.blob.core.windows.net/'." } ] }, { "name": "list-usage", "description": "Get usage of compute resources.", "fullName": "vm list-usage", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "enable-diag", "description": "Enable diagnostics extension on a VM in a resource group.", "fullName": "vm enable-diag", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-a, --storage-account-name ", "required": -28, "optional": 0, "bool": true, "short": "-a", "long": "--storage-account-name", "description": "the storage account name" }, { "flags": "-c, --config-file ", "required": -19, "optional": 0, "bool": true, "short": "-c", "long": "--config-file", "description": "path for WadCfg config file (collect basic metrics if not specified)" }, { "flags": "-e, --extension-version ", "required": -25, "optional": 0, "bool": true, "short": "-e", "long": "--extension-version", "description": "Version of Diagnostics extension. Default values are [1.5] for Windows and [2.3] for Linux." }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "enable-disk-encryption", "description": "Enable azure disk encryption on a VM in a resource group.", "fullName": "vm enable-disk-encryption", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-a, --aad-client-id ", "required": -21, "optional": 0, "bool": true, "short": "-a", "long": "--aad-client-id", "description": "Client ID of AAD app with permissions to write secrets to KeyVault" }, { "flags": "-p, --aad-client-secret ", "required": -25, "optional": 0, "bool": true, "short": "-p", "long": "--aad-client-secret", "description": "Client Secret of AAD app with permissions to write secrets to KeyVault" }, { "flags": "-c, --aad-client-cert-thumbprint ", "required": -34, "optional": 0, "bool": true, "short": "-c", "long": "--aad-client-cert-thumbprint", "description": "Thumbprint of AAD app certificate with permissions to write secrets to KeyVault" }, { "flags": "-k, --disk-encryption-key-vault-url ", "required": -37, "optional": 0, "bool": true, "short": "-k", "long": "--disk-encryption-key-vault-url", "description": "URL of the KeyVault where generated encryption key will be placed to" }, { "flags": "-r, --disk-encryption-key-vault-id ", "required": -36, "optional": 0, "bool": true, "short": "-r", "long": "--disk-encryption-key-vault-id", "description": "ResourceID of the KeyVault where generated encryption key will be placed to" }, { "flags": "-u, --key-encryption-key-url ", "required": -30, "optional": 0, "bool": true, "short": "-u", "long": "--key-encryption-key-url", "description": "Versioned KeyVault URL of the KeyEncryptionKey used to encrypt the disk encryption key" }, { "flags": "-i, --key-encryption-key-vault-id ", "required": -35, "optional": 0, "bool": true, "short": "-i", "long": "--key-encryption-key-vault-id", "description": "ResourceID of the KeyVault containing the KeyEncryptionKey used to encrypt the disk encryption key" }, { "flags": "-l, --key-encryption-algorithm ", "required": -32, "optional": 0, "bool": true, "short": "-l", "long": "--key-encryption-algorithm", "description": "KeyEncryption Algorithm used to encrypt the volume encryption key" }, { "flags": "-t, --volume-type ", "required": -19, "optional": 0, "bool": true, "short": "-t", "long": "--volume-type", "description": "Type of the volume OS or Data or All to perform encryption operation" }, { "flags": "-x, --sequence-version ", "required": -24, "optional": 0, "bool": true, "short": "-x", "long": "--sequence-version", "description": "Sequence version of encryption operation. This must be incremented to perform repeated encryption operations on the same VM" }, { "flags": "-b, --passphrase ", "required": -18, "optional": 0, "bool": true, "short": "-b", "long": "--passphrase", "description": "Passphrase specified in parameter" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for confirmation" }, { "flags": "-e, --extension-version ", "required": -25, "optional": 0, "bool": true, "short": "-e", "long": "--extension-version", "description": "Version of AzureDiskEncryption extension. Default values are [1.1] for Windows" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" }, { "flags": "-d, --disable-auto-upgrade-minor-version", "required": 0, "optional": 0, "bool": true, "short": "-d", "long": "--disable-auto-upgrade-minor-version", "description": "Disable auto-upgrade of minor version" } ] }, { "name": "delete-backup", "description": "Deletes the backup for the vm", "fullName": "vm delete-backup", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-i, --identity ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--identity", "description": "The identity of the backup" } ] }, { "name": "show-disk-encryption-status", "description": "Show azure disk encryption status of a VM in a resource group.", "fullName": "vm show-disk-encryption-status", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "disable-disk-encryption", "description": "Disable azure disk encryption on a VM in a resource group.", "fullName": "vm disable-disk-encryption", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-t, --volume-type ", "required": -19, "optional": 0, "bool": true, "short": "-t", "long": "--volume-type", "description": "Type of the volume OS or Data or All to perform encryption operation" }, { "flags": "-x, --sequence-version ", "required": -24, "optional": 0, "bool": true, "short": "-x", "long": "--sequence-version", "description": "Sequence version of encryption operation. This must be incremented to perform repeated encryption operations on the same VM" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for confirmation" }, { "flags": "-e, --extension-version ", "required": -25, "optional": 0, "bool": true, "short": "-e", "long": "--extension-version", "description": "Version of AzureDiskEncryption extension. Default values are [1.1] for Windows" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" }, { "flags": "-d, --disable-auto-upgrade-minor-version", "required": 0, "optional": 0, "bool": true, "short": "-d", "long": "--disable-auto-upgrade-minor-version", "description": "Disable auto-upgrade of minor version" } ] } ], "categories": { "disk": { "name": "disk", "description": "Commands to manage your Virtual Machine data disks", "fullName": "vm disk", "usage": "[options] [command]", "options": [], "commands": [ { "name": "attach-new", "description": "Attach a new data-disk to a VM in a resource group", "fullName": "vm disk attach-new", "usage": "[options] [vhd-name]", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-n", "long": "--vm-name", "description": "the virtual machine name" }, { "flags": "-z, --size-in-gb ", "required": -18, "optional": 0, "bool": true, "short": "-z", "long": "--size-in-gb", "description": "the disk size in GB" }, { "flags": "-d, --vhd-name ", "required": -16, "optional": 0, "bool": true, "short": "-d", "long": "--vhd-name", "description": "the name for the new VHD" }, { "flags": "-c, --host-caching ", "required": -20, "optional": 0, "bool": true, "short": "-c", "long": "--host-caching", "description": "the caching behaviour of disk [None, ReadOnly, ReadWrite]" }, { "flags": "-o, --storage-account-name ", "required": -28, "optional": 0, "bool": true, "short": "-o", "long": "--storage-account-name", "description": "the storage account name" }, { "flags": "-r, --storage-account-container-name ", "required": -38, "optional": 0, "bool": true, "short": "-r", "long": "--storage-account-container-name", "description": "the storage account container name [vhds]" }, { "flags": "-l, --lun ", "required": -11, "optional": 0, "bool": true, "short": "-l", "long": "--lun", "description": "zero based logical unit number of the data disk" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "detach", "description": "Detach a data-disk attached to a VM in a resource group", "fullName": "vm disk detach", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-n", "long": "--vm-name", "description": "the virtual machine name" }, { "flags": "-l, --lun ", "required": -11, "optional": 0, "bool": true, "short": "-l", "long": "--lun", "description": "the data disk lun" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "attach", "description": "Attach a new data-disk to a VM in a resource group", "fullName": "vm disk attach", "usage": "[options] [vhd-url]", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-n", "long": "--vm-name", "description": "the virtual machine name" }, { "flags": "-d, --vhd-url ", "required": -15, "optional": 0, "bool": true, "short": "-d", "long": "--vhd-url", "description": "the URL of existing VHD" }, { "flags": "-c, --host-caching ", "required": -20, "optional": 0, "bool": true, "short": "-c", "long": "--host-caching", "description": "the caching behaviour of disk [None, ReadOnly, ReadWrite]" }, { "flags": "-l, --lun ", "required": -11, "optional": 0, "bool": true, "short": "-l", "long": "--lun", "description": "zero based logical unit number of the data disk" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "list", "description": "Get all data disks of a VM in a resource group", "fullName": "vm disk list", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-n, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-n", "long": "--vm-name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] } ], "categories": {} }, "extension": { "name": "extension", "description": "Commands to manage VM resource extensions", "fullName": "vm extension", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Enable/disable resource extensions for a VM in a resource group", "fullName": "vm extension set", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-m, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-m", "long": "--vm-name", "description": "the virtual machine name" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the extension name" }, { "flags": "-p, --publisher-name ", "required": -22, "optional": 0, "bool": true, "short": "-p", "long": "--publisher-name", "description": "the publisher name" }, { "flags": "-o, --version ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--version", "description": "the extension version" }, { "flags": "-r, --reference-name ", "required": -22, "optional": 0, "bool": true, "short": "-r", "long": "--reference-name", "description": "extension's reference name" }, { "flags": "-i, --public-config ", "required": -21, "optional": 0, "bool": true, "short": "-i", "long": "--public-config", "description": "public configuration text" }, { "flags": "-c, --public-config-path ", "required": -26, "optional": 0, "bool": true, "short": "-c", "long": "--public-config-path", "description": "public configuration file path" }, { "flags": "-f, --private-config ", "required": -22, "optional": 0, "bool": true, "short": "-f", "long": "--private-config", "description": "private configuration text" }, { "flags": "-e, --private-config-path ", "required": -27, "optional": 0, "bool": true, "short": "-e", "long": "--private-config-path", "description": "private configuration file path" }, { "flags": "-u, --uninstall", "required": 0, "optional": 0, "bool": true, "short": "-u", "long": "--uninstall", "description": "uninstall extension" }, { "flags": "-t, --tags ", "required": -12, "optional": 0, "bool": true, "short": "-t", "long": "--tags", "description": "Tags to set to the resource group. Can be mutliple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for uninstall confirmation" }, { "flags": "-U, --auto-upgrade-minor-version", "required": 0, "optional": 0, "bool": true, "short": "-U", "long": "--auto-upgrade-minor-version", "description": "Enable auto-upgrade across minor version" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "set-chef", "description": "Enable/disable chef extension for a VM in a resource group", "fullName": "vm extension set-chef", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-m, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-m", "long": "--vm-name", "description": "the virtual machine name" }, { "flags": "-o, --version ", "required": -15, "optional": 0, "bool": true, "short": "-o", "long": "--version", "description": "the extension version" }, { "flags": "-R, --run-list ", "required": -16, "optional": 0, "bool": true, "short": "-R", "long": "--run-list", "description": "Runlist of roles/recipes to apply to VM" }, { "flags": "-O, --validation-pem ", "required": -22, "optional": 0, "bool": true, "short": "-O", "long": "--validation-pem", "description": "chef validation pem file path. Not required if -C or --client-pem option specified" }, { "flags": "-c, --client-config ", "required": -21, "optional": 0, "bool": true, "short": "-c", "long": "--client-config", "description": "chef client configuration file(i.e client.rb) path" }, { "flags": "-C, --client-pem ", "required": -18, "optional": 0, "bool": true, "short": "-C", "long": "--client-pem", "description": "chef client pem file path i.e required in validator less bootstrap" }, { "flags": "-j, --bootstrap-options ", "required": -25, "optional": 0, "bool": true, "short": "-j", "long": "--bootstrap-options", "description": "Bootstrap options in JSON format. Ex: -j '{\"chef_node_name\":\"test_node\"}'" }, { "flags": "-u, --uninstall", "required": 0, "optional": 0, "bool": true, "short": "-u", "long": "--uninstall", "description": "uninstall extension" }, { "flags": "-t, --tags ", "required": -12, "optional": 0, "bool": true, "short": "-t", "long": "--tags", "description": "Tags to set to the resource group. Can be multiple. In the format of 'name=value'. Name is required and value is optional. For example, -t tag1=value1;tag2" }, { "flags": "-q, --quiet", "required": 0, "optional": 0, "bool": true, "short": "-q", "long": "--quiet", "description": "quiet mode, do not ask for uninstall confirmation" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "get", "description": "Get extensions installed on a virtual machine in a resource group", "fullName": "vm extension get", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-m, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-m", "long": "--vm-name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] }, { "name": "get-chef", "description": "Get chef extension installed on a virtual machine in a resource group", "fullName": "vm extension get-chef", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the resource group name" }, { "flags": "-m, --vm-name ", "required": -15, "optional": 0, "bool": true, "short": "-m", "long": "--vm-name", "description": "the virtual machine name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription id" } ] } ], "categories": {} }, "extension-image": { "name": "extension-image", "description": "Commands to query available VM resource extensions", "fullName": "vm extension-image", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list-publishers", "description": "Lists virtual machine/extension image publishers", "fullName": "vm extension-image list-publishers", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list-types", "description": "Lists virtual machine extension image types by a publisher", "fullName": "vm extension-image list-types", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-p, --publisher ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--publisher", "description": "the publisher name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list-versions", "description": "Lists virtual machine extension image versions by publisher and type input", "fullName": "vm extension-image list-versions", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-p, --publisher ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--publisher", "description": "the publisher name" }, { "flags": "-t, --typeName ", "required": -16, "optional": 0, "bool": true, "short": "-t", "long": "--typeName", "description": "the type name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list", "description": "Lists virtual machine extension images by publisher, and type input", "fullName": "vm extension-image list", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-p, --publisher ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--publisher", "description": "the publisher name" }, { "flags": "-t, --typeName ", "required": -16, "optional": 0, "bool": true, "short": "-t", "long": "--typeName", "description": "the type name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "show", "description": "Lists virtual machine extension image versions by publisher, type and version input", "fullName": "vm extension-image show", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-p, --publisher ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--publisher", "description": "the publisher name" }, { "flags": "-t, --typeName ", "required": -16, "optional": 0, "bool": true, "short": "-t", "long": "--typeName", "description": "the type name" }, { "flags": "-v, --version ", "required": -15, "optional": 0, "bool": true, "short": "-v", "long": "--version", "description": "the version" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] } ], "categories": {} }, "docker": { "name": "docker", "description": "Commands to manage your Docker Virtual Machine", "fullName": "vm docker", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create a Docker virtual machine in a resource group", "fullName": "vm docker create", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-g, --resource-group ", "required": -22, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the name of the resource group" }, { "flags": "-n, --name ", "required": -12, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the virtual machine name" }, { "flags": "-T, --docker-port ", "required": -19, "optional": 0, "bool": true, "short": "-T", "long": "--docker-port", "description": "Port to use for docker [2376]" }, { "flags": "-O, --docker-cert-dir ", "required": -23, "optional": 0, "bool": true, "short": "-O", "long": "--docker-cert-dir", "description": "Directory containing docker certs [~/.docker/]" }, { "flags": "-E, --docker-extension-version ", "required": -32, "optional": 0, "bool": true, "short": "-E", "long": "--docker-extension-version", "description": "Version of Docker Azure extension [1.0]" }, { "flags": "-c, --docker-cert-cn [CN]", "required": 0, "optional": -22, "bool": true, "short": "-c", "long": "--docker-cert-cn", "description": "Docker server certificate's CN. Can be set if you are using --tlsverify option for Docker connections. Default value is [*]" }, { "flags": "-D, --nic-id ", "required": -14, "optional": 0, "bool": true, "short": "-D", "long": "--nic-id", "description": "the NIC identifier\n e.g. /subscriptions//resourceGroups//providers/Microsoft.Network/networkInterfaces/" }, { "flags": "-f, --nic-name ", "required": -16, "optional": 0, "bool": true, "short": "-f", "long": "--nic-name", "description": "the NIC name\n If this is an existing NIC then it must exists under the current resource group identified by resource-group\n A new NIC will be created if no NIC exists with name nic-name in the current resource group\n To create new NIC - subnet-id or vnet-name, vnet-address-prefix, subnet-name and vnet-subnet-address-prefix are required\n Please use nic-id to refer an existing NIC in a different resource group\n The parameter nic-name will be ignored when nic-id is specified" }, { "flags": "-I, --nic-ids ", "required": -15, "optional": 0, "bool": true, "short": "-I", "long": "--nic-ids", "description": "the list of NIC identifiers separated by comma. In case of specifying multiple nics first one will be set as primary." }, { "flags": "-N, --nic-names ", "required": -17, "optional": 0, "bool": true, "short": "-N", "long": "--nic-names", "description": "the list of NIC names separated by comma. In case of specifying multiple nics first one will be set as primary.These NICs must exists in the same resource group as the VM. Please use nic-ids if that not the case. This parameter will be ignored if --nic-ids is specified" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-y, --os-type ", "required": -15, "optional": 0, "bool": true, "short": "-y", "long": "--os-type", "description": "the operating system Type, valid values are Windows, Linux" }, { "flags": "-Q, --image-urn ", "required": -17, "optional": 0, "bool": true, "short": "-Q", "long": "--image-urn", "description": "the image URN in the form publisherName:offer:skus:version" }, { "flags": "-u, --admin-username ", "required": -22, "optional": 0, "bool": true, "short": "-u", "long": "--admin-username", "description": "the user name\n This parameter is valid for a VM created from an image (image-urn) and ignored when VM is based on disk (os-disk-*)" }, { "flags": "-p, --admin-password ", "required": -22, "optional": 0, "bool": true, "short": "-p", "long": "--admin-password", "description": "the password\n This parameter is valid for a VM created from an image (image-urn) and ignored when VM is based on disk (os-disk-*)" }, { "flags": "-M, --ssh-publickey-file ", "required": -26, "optional": 0, "bool": true, "short": "-M", "long": "--ssh-publickey-file", "description": "path to public key PEM file or SSH Public key file for SSH authentication\n This parameter is valid only when os-type is \"Linux\"" }, { "flags": "-G, --generate-ssh-keys", "required": 0, "optional": 0, "bool": true, "short": "-G", "long": "--generate-ssh-keys", "description": "Auto generate SSH keys, --ssh-publickey-file will be ignored. This parameter is valid only when os-type is \"Linux\"" }, { "flags": "-z, --vm-size ", "required": -15, "optional": 0, "bool": true, "short": "-z", "long": "--vm-size", "description": "the virtual machine size [Standard_A1]" }, { "flags": "-U, --public-ip-id ", "required": -20, "optional": 0, "bool": true, "short": "-U", "long": "--public-ip-id", "description": "the public ip identifier\n e.g. /subscriptions//resourceGroups//providers/Microsoft.Network/publicIPAddresses/" }, { "flags": "-i, --public-ip-name ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--public-ip-name", "description": "the public ip name\n If this is an existing public IP then it must exists under the current resource group identified by resource-group\n A new public IP will be created if no public IP exists with name public-ip-name in the current resource group\n Please use public-ip-id to refer an existing public IP in a different resource group\n The parameter public-ip-name will be ignored when public-ip-id is specified" }, { "flags": "-w, --public-ip-domain-name ", "required": -29, "optional": 0, "bool": true, "short": "-w", "long": "--public-ip-domain-name", "description": "the public ip domain name\n This sets the DNS to ..cloudapp.azure.com\n This parameter will be used only when creating new public IP" }, { "flags": "-m, --public-ip-allocationmethod ", "required": -34, "optional": 0, "bool": true, "short": "-m", "long": "--public-ip-allocationmethod", "description": "the public ip allocation method, valid values are \"Dynamic\"\n This parameter will be used only when creating new public IP" }, { "flags": "-t, --public-ip-idletimeout ", "required": -29, "optional": 0, "bool": true, "short": "-t", "long": "--public-ip-idletimeout", "description": "the public ip idle timeout specified in minutes\n This parameter will be used only when creating new public IP" }, { "flags": "-S, --subnet-id ", "required": -17, "optional": 0, "bool": true, "short": "-S", "long": "--subnet-id", "description": "the subnet identifier\n e.g. /subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/" }, { "flags": "-F, --vnet-name ", "required": -17, "optional": 0, "bool": true, "short": "-F", "long": "--vnet-name", "description": "the virtual network name\n If this is an existing vnet then it must exists under the current resource group identified by resource-group\n If this is an existing vnet then vnet-subnet-name is required\n If no subnet exists with name vnet-subnet-name then a new subnet will be created\n To create new subnet vnet-subnet-address-prefix is required\n A new vnet will be created if no vnet exists with name vnet-name in the current resource group\n To create new vnet, vnet-address-prefix, vnet-subnet-name and vnet-subnet-address-prefix are required\n Please use subnet-id to refer an existing subnet under a vnet in a different resource group\n vnet-name, vnet-address-prefix, vnet-subnet-name and vnet-subnet-address-prefix will be ignored when subnet-id is specified" }, { "flags": "-P, --vnet-address-prefix ", "required": -27, "optional": 0, "bool": true, "short": "-P", "long": "--vnet-address-prefix", "description": "the virtual network address prefix in IPv4/CIDR format" }, { "flags": "-j, --vnet-subnet-name ", "required": -24, "optional": 0, "bool": true, "short": "-j", "long": "--vnet-subnet-name", "description": "the virtual network subnet name" }, { "flags": "-k, --vnet-subnet-address-prefix ", "required": -34, "optional": 0, "bool": true, "short": "-k", "long": "--vnet-subnet-address-prefix", "description": "the virtual network subnet address prefix in IPv4/CIDR format" }, { "flags": "-r, --availset-name ", "required": -21, "optional": 0, "bool": true, "short": "-r", "long": "--availset-name", "description": "the availability set name" }, { "flags": "-o, --storage-account-name ", "required": -28, "optional": 0, "bool": true, "short": "-o", "long": "--storage-account-name", "description": "the storage account name" }, { "flags": "-R, --storage-account-container-name ", "required": -38, "optional": 0, "bool": true, "short": "-R", "long": "--storage-account-container-name", "description": "the storage account container name [vhds]" }, { "flags": "-d, --os-disk-vhd ", "required": -19, "optional": 0, "bool": true, "short": "-d", "long": "--os-disk-vhd", "description": "name or url of the OS disk Vhd\n If this parameter is specified along with --image-urn parameter then OS disk created from the image will be stored in this vhd\n If this parameter is specified without --image-urn parameter then this vhd must exists and will be used as OS Disk" }, { "flags": "-a, --data-disk-caching ", "required": -25, "optional": 0, "bool": true, "short": "-a", "long": "--data-disk-caching", "description": "data disk caching, valid values are None, ReadOnly, ReadWrite" }, { "flags": "-x, --data-disk-vhd ", "required": -21, "optional": 0, "bool": true, "short": "-x", "long": "--data-disk-vhd", "description": "name or url of the data disk Vhd" }, { "flags": "-e, --data-disk-size ", "required": -22, "optional": 0, "bool": true, "short": "-e", "long": "--data-disk-size", "description": "data disk size in GB" }, { "flags": "-Y, --data-disk-existing", "required": 0, "optional": 0, "bool": true, "short": "-Y", "long": "--data-disk-existing", "description": "Will use existing VHD if specified. Don't specify this param if you are creating data disk from a new VHD." }, { "flags": "-C, --custom-data ", "required": -19, "optional": 0, "bool": true, "short": "-C", "long": "--custom-data", "description": "CustomData file" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] } ], "categories": {} }, "image": { "name": "image", "description": "Commands to manage VM images", "fullName": "vm image", "usage": "[options] [command]", "options": [], "commands": [ { "name": "list-publishers", "description": "Lists virtual machines image publishers", "fullName": "vm image list-publishers", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list-offers", "description": "Lists virtual machines image offers by a publisher", "fullName": "vm image list-offers", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-p, --publisher ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--publisher", "description": "the publisher name" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list-skus", "description": "Lists virtual machines image skus for a specific offer from a publisher", "fullName": "vm image list-skus", "usage": "[options] ", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-p, --publisher ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--publisher", "description": "the publisher name" }, { "flags": "-o, --offer ", "required": -13, "optional": 0, "bool": true, "short": "-o", "long": "--offer", "description": "the offer" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list", "description": "Lists the virtual machines images", "fullName": "vm image list", "usage": "[options] [offer] [sku]", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-p, --publisher ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--publisher", "description": "the publisher name" }, { "flags": "-o, --offer ", "required": -13, "optional": 0, "bool": true, "short": "-o", "long": "--offer", "description": "the offer" }, { "flags": "-k, --sku ", "required": -11, "optional": 0, "bool": true, "short": "-k", "long": "--sku", "description": "the sku" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "show", "description": "Lists the virtual machines images", "fullName": "vm image show", "usage": "[options] [offer] [sku]", "filePath": "commands/arm/vm/vm.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "more verbose with debug output" }, { "flags": "--json", "required": 0, "optional": 0, "bool": true, "long": "--json", "description": "use json output" }, { "flags": "-l, --location ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the location" }, { "flags": "-p, --publisher ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--publisher", "description": "the publisher name" }, { "flags": "-o, --offer ", "required": -13, "optional": 0, "bool": true, "short": "-o", "long": "--offer", "description": "the offer" }, { "flags": "-k, --sku ", "required": -11, "optional": 0, "bool": true, "short": "-k", "long": "--sku", "description": "the sku" }, { "flags": "-e, --version ", "required": -15, "optional": 0, "bool": true, "short": "-e", "long": "--version", "description": "the version" }, { "flags": "-s, --subscription ", "required": -20, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] } ], "categories": {} } } }, "datalake": { "name": "datalake", "description": "Commands to manage your Data Lake objects", "fullName": "datalake", "usage": "[options]", "options": [], "commands": [], "categories": { "analytics": { "name": "analytics", "description": "Commands to manage your Data Lake Analytics objects", "fullName": "datalake analytics", "usage": "[options]", "options": [], "commands": [], "categories": { "job": { "name": "job", "description": "Commands to manage your Data Lake Analytics Jobs", "fullName": "datalake analytics job", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Submits a job to the specified Data Lake Analytics account.", "fullName": "datalake analytics job create", "usage": "[options]