{ "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": { "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 display 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 display name for the application" }, { "flags": "--default-version ", "required": -19, "optional": 0, "bool": true, "long": "--default-version", "description": "the package to use if a client requests the application but does not specify a version" }, { "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.applicationPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.applicationPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.applicationPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.applicationPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": {} } } }, "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.batchAccount.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.batchAccount.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.batchAccount.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.batchAccount.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.batchAccount.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.batchAccount.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.batchAccount.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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.batchAccount.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": {} } } }, "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 specified 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 entities 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 entities 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 specified pool" }, { "flags": "--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 format" }, { "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 specified 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 job may be created under this job schedule; if you do not specify a time, the schedule 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 entities 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 entities 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 specified 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 job may be created under this job schedule; if you do not specify a time, the schedule 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": {} }, "location": { "name": "location", "description": "Commands to manage Batch service options for a subscription at the region level", "fullName": "batch location", "usage": "[options]", "options": [], "commands": [], "categories": { "quotas": { "name": "quotas", "description": "Commands to manage Batch service quotas at the region level", "fullName": "batch location quotas", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Get the Batch service quotas for the specified subscription at the given region", "fullName": "batch location quotas show", "usage": "[options] ", "filePath": "commands/batch/batch.location.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": {} } } }, "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 entities 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 entities 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": {} } } }, "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 entities 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 entities 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" } ] }, { "name": "reactivate", "description": "Reactivate the specified Batch task", "fullName": "batch task reactivate", "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": "--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": {} }, "servicefabric": { "name": "servicefabric", "description": "Commands to manage your Azure Service Fabric", "fullName": "servicefabric", "usage": "[options]", "options": [], "commands": [], "categories": { "application": { "name": "application", "description": "Commands to manage your application", "fullName": "servicefabric application", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show application", "fullName": "servicefabric application show", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "create", "description": "Create application, Example: azure servicefabric application create --application-name fabric:/app --application-type-name type1 --application-type-version 1.0", "fullName": "servicefabric application create", "usage": "[options] [applicationName] [applicationTypeName] [applicationTypeVersion]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-t --application-type-name ", "required": -28, "optional": 0, "bool": true, "short": "-t", "long": "--application-type-name", "description": "the name of the application type" }, { "flags": "-a --application-type-version ", "required": -31, "optional": 0, "bool": true, "short": "-a", "long": "--application-type-version", "description": "the version of the application type" }, { "flags": "-p --application-parameter ", "required": -28, "optional": 0, "bool": true, "short": "-p", "long": "--application-parameter", "description": "the parameter of the application, json string \"{\"Key\": \"key1\", \"Value\": \"value1\"}\"" } ] }, { "name": "delete", "description": "Delete application", "fullName": "servicefabric application delete", "usage": "[options] [applicationName]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" } ] } ], "categories": { "manifest": { "name": "manifest", "description": "Commands to manage your application manifest", "fullName": "servicefabric application manifest", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show application manifest", "fullName": "servicefabric application manifest show", "usage": "[options] [applicationTypeName] [applicationTypeVersion]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-type-name ", "required": -28, "optional": 0, "bool": true, "short": "-n", "long": "--application-type-name", "description": "the name of the application type" }, { "flags": "-t --application-type-version ", "required": -31, "optional": 0, "bool": true, "short": "-t", "long": "--application-type-version", "description": "the type of the application version" } ] } ], "categories": {} }, "type": { "name": "type", "description": "Commands to manage your application type", "fullName": "servicefabric application type", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show application type, Example: azure servicefabric application type show --application-type-name type1", "fullName": "servicefabric application type show", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-type-name ", "required": -28, "optional": 0, "bool": true, "short": "-n", "long": "--application-type-name", "description": "the type of the application" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "register", "description": "Register application type, Example: azure servicefabric application type register --application-type-build-path Package1", "fullName": "servicefabric application type register", "usage": "[options] [applicationTypeBuildPath]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-type-build-path ", "required": -34, "optional": 0, "bool": true, "short": "-p", "long": "--application-type-build-path", "description": "the path of the application type build" }, { "flags": "-t --timeout ", "required": -14, "optional": 0, "bool": true, "short": "-t", "long": "--timeout", "description": "the timeout, seconds" } ] }, { "name": "unregister", "description": "Unregister application type, Example: azure servicefabric application type unregister --application-type-name type1 --application-type-version 1.0", "fullName": "servicefabric application type unregister", "usage": "[options] [applicationTypeName] [applicationTypeVersion]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-type-name ", "required": -28, "optional": 0, "bool": true, "short": "-n", "long": "--application-type-name", "description": "the name of the application type" }, { "flags": "-t --application-type-version ", "required": -31, "optional": 0, "bool": true, "short": "-t", "long": "--application-type-version", "description": "the version of the application type" } ] } ], "categories": {} }, "health": { "name": "health", "description": "Commands to send your application health", "fullName": "servicefabric application health", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show application health", "fullName": "servicefabric application health show", "usage": "[options] [applicationName]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --events-health-state-filter ", "required": -33, "optional": 0, "bool": true, "short": "-e", "long": "--events-health-state-filter", "description": "the filter of the event health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "-f --deployed-applications-health-state-filter ", "required": -48, "optional": 0, "bool": true, "short": "-f", "long": "--deployed-applications-health-state-filter", "description": "the filter of the deployed applications health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "send", "description": "Send application health, Example: azure servicefabric application health send --application-name fabric:app --source-id monitor --property pc --health-state Ok --description healthy", "fullName": "servicefabric application health send", "usage": "[options] [applicationName] [sourceId] [property] [healthState]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-i --source-id ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--source-id", "description": "the id of the source" }, { "flags": "-p --property ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--property", "description": "the property" }, { "flags": "-e --health-state ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--health-state", "description": "the state of the health, values are [Ok|Warning|Error|Unknown]" }, { "flags": "-d --description ", "required": -18, "optional": 0, "bool": true, "short": "-d", "long": "--description", "description": "the description" }, { "flags": "-m --time-to-live-in-milliSeconds ", "required": -35, "optional": 0, "bool": true, "short": "-m", "long": "--time-to-live-in-milliSeconds", "description": "the time in milliseconds for live" }, { "flags": "-q --sequence-number ", "required": -22, "optional": 0, "bool": true, "short": "-q", "long": "--sequence-number", "description": "the number of the sequence" }, { "flags": "-w --remove-when-expired", "required": 0, "optional": 0, "bool": true, "short": "-w", "long": "--remove-when-expired", "description": "the boolean of the remove when expired" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} }, "deployed": { "name": "deployed", "description": "Commands to manage your deployed application", "fullName": "servicefabric application deployed", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show deployed application", "fullName": "servicefabric application deployed show", "usage": "[options] [nodeName]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-a --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--application-name", "description": "the name of the application" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": { "health": { "name": "health", "description": "Commands to manage your deployed application health", "fullName": "servicefabric application deployed health", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show deployed application health", "fullName": "servicefabric application deployed health show", "usage": "[options] [nodeName] [applicationName]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-a --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--application-name", "description": "the name of the application" }, { "flags": "-f --events-health-state-filter ", "required": -33, "optional": 0, "bool": true, "short": "-f", "long": "--events-health-state-filter", "description": "the filter of the event health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "-p --deployed-service-packages-health-state-filter ", "required": -52, "optional": 0, "bool": true, "short": "-p", "long": "--deployed-service-packages-health-state-filter", "description": "the filter of the deployed service packages health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "send", "description": "Send deployed application health, Example: azure servicefabric deployed application health send --node-name node1 --application-name fabric:app --source-id monitor --property pc --health-state Ok --description healthy", "fullName": "servicefabric application deployed health send", "usage": "[options] [nodeName] [applicationName] [sourceId] [property] [healthState]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-a --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--application-name", "description": "the name of the application" }, { "flags": "-i --source-id ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--source-id", "description": "the id of the source" }, { "flags": "-p --property ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--property", "description": "the property" }, { "flags": "-e --health-state ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--health-state", "description": "the state of the health, values are [Ok|Warning|Error|Unknown]" }, { "flags": "-d --description ", "required": -18, "optional": 0, "bool": true, "short": "-d", "long": "--description", "description": "the description" }, { "flags": "-t --time-to-live-in-milliseconds ", "required": -35, "optional": 0, "bool": true, "short": "-t", "long": "--time-to-live-in-milliseconds", "description": "the time in milliseconds for live" }, { "flags": "-q --sequence-number ", "required": -22, "optional": 0, "bool": true, "short": "-q", "long": "--sequence-number", "description": "the number of the sequence" }, { "flags": "-r --remove-when-expired", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--remove-when-expired", "description": "the boolean of the remove when expired" } ] } ], "categories": {} } } }, "upgrade": { "name": "upgrade", "description": "Commands to manage your application upgrade", "fullName": "servicefabric application upgrade", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show application upgrade", "fullName": "servicefabric application upgrade show", "usage": "[options] [applicationName]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" } ] }, { "name": "start", "description": "Start application upgrade, Example: azure servicefabric application upgrade start --application-name fabric:/app --target-application-type-version 1.1 --rolling-upgrade-mode Monitored --force-restart true", "fullName": "servicefabric application upgrade start", "usage": "[options] [applicationName] [targetApplicationTypeVersion] [rollingUpgradeMode]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-t --target-application-type-version ", "required": -38, "optional": 0, "bool": true, "short": "-t", "long": "--target-application-type-version", "description": "the version of the target application type" }, { "flags": "-p --parameters ", "required": -17, "optional": 0, "bool": true, "short": "-p", "long": "--parameters", "description": "the parameters, json string \"{\"Key\": \"key1\", \"Value\": \"value1\"}\"" }, { "flags": "-m --rolling-upgrade-mode ", "required": -27, "optional": 0, "bool": true, "short": "-m", "long": "--rolling-upgrade-mode", "description": "the mode of the rolling upgrade, values are [UnmonitoredAuto|UnmonitoredManual|Monitored]" }, { "flags": "-r --upgrade-replica-set-check-timeout-in-seconds ", "required": -51, "optional": 0, "bool": true, "short": "-r", "long": "--upgrade-replica-set-check-timeout-in-seconds", "description": "the name of the upgrade domain" }, { "flags": "-f --force-restart", "required": 0, "optional": 0, "bool": true, "short": "-f", "long": "--force-restart", "description": "the force restart" }, { "flags": "-o --monitoring-policy ", "required": -24, "optional": 0, "bool": true, "short": "-o", "long": "--monitoring-policy", "description": "the policy of the monitoring" }, { "flags": "-a --application-health-policy ", "required": -32, "optional": 0, "bool": true, "short": "-a", "long": "--application-health-policy", "description": "the policy of the health application" } ] }, { "name": "update", "description": "Update application upgrade, Example: azure servicefabric application upgrade update --application-name fabric:/app --rolling-upgrade-mode Monitored", "fullName": "servicefabric application upgrade update", "usage": "[options] [applicationName]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-m --rolling-upgrade-mode ", "required": -27, "optional": 0, "bool": true, "short": "-m", "long": "--rolling-upgrade-mode", "description": "the mode of the rolling upgrade, values are [UnmonitoredAuto|UnmonitoredManual|Monitored]" }, { "flags": "-r --force-restart", "required": 0, "optional": 0, "bool": true, "short": "-r", "long": "--force-restart", "description": "the boolean of the force restart" }, { "flags": "-a --failure-action ", "required": -21, "optional": 0, "bool": true, "short": "-a", "long": "--failure-action", "description": "the mode of the failure action, values are [Rollback|Manual]" }, { "flags": "-i --upgrade-replica-set-check-timeout-in-seconds ", "required": -51, "optional": 0, "bool": true, "short": "-i", "long": "--upgrade-replica-set-check-timeout-in-seconds", "description": "the mode of the rolling upgrade" }, { "flags": "-d --health-check-wait-duration-in-milliseconds ", "required": -49, "optional": 0, "bool": true, "short": "-d", "long": "--health-check-wait-duration-in-milliseconds", "description": "the mode of the rolling upgrade" }, { "flags": "-c --health-check-stable-duration-in-milliseconds ", "required": -51, "optional": 0, "bool": true, "short": "-c", "long": "--health-check-stable-duration-in-milliseconds", "description": "the mode of the rolling upgrade" }, { "flags": "-e --health-check-retry-timeout-in-milliseconds ", "required": -49, "optional": 0, "bool": true, "short": "-e", "long": "--health-check-retry-timeout-in-milliseconds", "description": "the mode of the rolling upgrade" }, { "flags": "-u --upgrade-timeout-in-milliseconds ", "required": -38, "optional": 0, "bool": true, "short": "-u", "long": "--upgrade-timeout-in-milliseconds", "description": "the mode of the rolling upgrade" }, { "flags": "-p --upgrade-domain-timeout-in-milliseconds ", "required": -45, "optional": 0, "bool": true, "short": "-p", "long": "--upgrade-domain-timeout-in-milliseconds", "description": "the mode of the rolling upgrade" }, { "flags": "-l --application-health-policy ", "required": -32, "optional": 0, "bool": true, "short": "-l", "long": "--application-health-policy", "description": "the policy of the health application" } ] }, { "name": "resume", "description": "Resume application upgrade", "fullName": "servicefabric application upgrade resume", "usage": "[options] [applicationName] [upgradeDomainName]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-d --upgrade-domain-name ", "required": -26, "optional": 0, "bool": true, "short": "-d", "long": "--upgrade-domain-name", "description": "the name of the upgrade domain" } ] }, { "name": "rollback", "description": "Start application upgrade rollback", "fullName": "servicefabric application upgrade rollback", "usage": "[options] [applicationName]", "filePath": "commands/servicefabric/serviceFabricApplication.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" } ] } ], "categories": {} }, "package": { "name": "package", "description": "Commands to manage your application package", "fullName": "servicefabric application package", "usage": "[options] [command]", "options": [], "commands": [ { "name": "copy", "description": "Copy application package, Example: azure servicefabric application package copy --application-package-path /tmp/package1 --image-store-connection-string fabric:ImageStore", "fullName": "servicefabric application package copy", "usage": "[options] [applicationPackagePath] [imageStoreConnectionString]", "filePath": "commands/servicefabric/serviceFabricPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-package-path ", "required": -31, "optional": 0, "bool": true, "short": "-p", "long": "--application-package-path", "description": "the path of the application package" }, { "flags": "-c --image-store-connection-string ", "required": -36, "optional": 0, "bool": true, "short": "-c", "long": "--image-store-connection-string", "description": "the string of the image store connection" } ] } ], "categories": {} } } }, "cluster": { "name": "cluster", "description": "Commands to manage your cluster", "fullName": "servicefabric cluster", "usage": "[options] [command]", "options": [], "commands": [ { "name": "connect", "description": "Connect cluster, Example: azure servicefabric cluster connect --connection-endpoint http://127.0.0.1:19080", "fullName": "servicefabric cluster connect", "usage": "[options] [connectionEndpoint]", "filePath": "commands/servicefabric/serviceFabricCluster.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --connection-endpoint ", "required": -26, "optional": 0, "bool": true, "short": "-e", "long": "--connection-endpoint", "description": "the url of the connection endpoint, value is [http|https]://[ip_address]" }, { "flags": "-p --client-key-path ", "required": -22, "optional": 0, "bool": true, "short": "-p", "long": "--client-key-path", "description": "the path of the client key" }, { "flags": "-c --client-cert-path ", "required": -23, "optional": 0, "bool": true, "short": "-c", "long": "--client-cert-path", "description": "the path of the client cert" }, { "flags": "-a --ca-cert-path ", "required": -19, "optional": 0, "bool": true, "short": "-a", "long": "--ca-cert-path", "description": "the path of the ca cert, comma separated if multiple" }, { "flags": "-t --strict-ssl-false", "required": 0, "optional": 0, "bool": true, "short": "-t", "long": "--strict-ssl-false", "description": "the boolean of the strict ssl, false to disable CN verification" }, { "flags": "-u --reject-unauthorized-false", "required": 0, "optional": 0, "bool": true, "short": "-u", "long": "--reject-unauthorized-false", "description": "the boolean of the reject unauthorized, false to disable CA verification" } ] }, { "name": "show", "description": "Show cluster", "fullName": "servicefabric cluster show", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricCluster.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": { "manifest": { "name": "manifest", "description": "Commands to manage your cluster manifest", "fullName": "servicefabric cluster manifest", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show cluster manifest", "fullName": "servicefabric cluster manifest show", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricCluster.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "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": {} }, "health": { "name": "health", "description": "Commands to manage your cluster health", "fullName": "servicefabric cluster health", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show cluster health", "fullName": "servicefabric cluster health show", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricCluster.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --events-health-state-filter ", "required": -33, "optional": 0, "bool": true, "short": "-f", "long": "--events-health-state-filter", "description": "the filter of the event health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "-n --nodes-health-state-filter ", "required": -32, "optional": 0, "bool": true, "short": "-n", "long": "--nodes-health-state-filter", "description": "the filter of the nodes health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "-a --applications-health-state-filter ", "required": -39, "optional": 0, "bool": true, "short": "-a", "long": "--applications-health-state-filter", "description": "the filter of the applications health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "send", "description": "Send cluster health, Example: azure servicefabric cluster health send --source-id monitor --property pc --health-state Ok --description healthy", "fullName": "servicefabric cluster health send", "usage": "[options] [sourceId] [property] [healthState]", "filePath": "commands/servicefabric/serviceFabricCluster.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --source-id ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--source-id", "description": "the id of the source" }, { "flags": "-p --property ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--property", "description": "the property" }, { "flags": "-e --health-state ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--health-state", "description": "the state of the health, values are [Ok|Warning|Error|Unknown]" }, { "flags": "-d --description ", "required": -18, "optional": 0, "bool": true, "short": "-d", "long": "--description", "description": "the description" }, { "flags": "-m --time-to-live-in-milliseconds ", "required": -35, "optional": 0, "bool": true, "short": "-m", "long": "--time-to-live-in-milliseconds", "description": "the time in milliseconds for live" }, { "flags": "-n --sequence-number ", "required": -22, "optional": 0, "bool": true, "short": "-n", "long": "--sequence-number", "description": "the number of the sequence" }, { "flags": "-o --remove-when-expired", "required": 0, "optional": 0, "bool": true, "short": "-o", "long": "--remove-when-expired", "description": "the boolean of the remove when expired" } ] } ], "categories": {} }, "load": { "name": "load", "description": "Commands to manage your cluster load information", "fullName": "servicefabric cluster load", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show load information", "fullName": "servicefabric cluster load show", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricCluster.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} }, "upgrade": { "name": "upgrade", "description": "Commands to manage your cluster upgrade", "fullName": "servicefabric cluster upgrade", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show cluster upgrade", "fullName": "servicefabric cluster upgrade show", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricCluster.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "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": {} } } }, "node": { "name": "node", "description": "Commands to manage your node", "fullName": "servicefabric node", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show node", "fullName": "servicefabric node show", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricNode.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "enable", "description": "Enable node, Example: azure servicefabric node enable --node-name node1", "fullName": "servicefabric node enable", "usage": "[options] [nodeName]", "filePath": "commands/servicefabric/serviceFabricNode.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" } ] }, { "name": "disable", "description": "Disable node, Example: azure servicefabric node enable --node-name node1 --deactivation-intent Pause", "fullName": "servicefabric node disable", "usage": "[options] [nodeName] [deactivationIntent]", "filePath": "commands/servicefabric/serviceFabricNode.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-i --deactivation-intent ", "required": -26, "optional": 0, "bool": true, "short": "-i", "long": "--deactivation-intent", "description": "the intent of the deactivation, values are [Pause|Restart|RemoveData|RemoveNode]" } ] } ], "categories": { "state": { "name": "state", "description": "Commands to manage your node load state", "fullName": "servicefabric node state", "usage": "[options] [command]", "options": [], "commands": [ { "name": "delete", "description": "Delete node state", "fullName": "servicefabric node state delete", "usage": "[options] [nodeName]", "filePath": "commands/servicefabric/serviceFabricNode.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" } ] } ], "categories": {} }, "load": { "name": "load", "description": "Commands to manage your node load", "fullName": "servicefabric node load", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show node load information", "fullName": "servicefabric node load show", "usage": "[options] [nodeName]", "filePath": "commands/servicefabric/serviceFabricNode.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} }, "health": { "name": "health", "description": "Commands to manage your node health", "fullName": "servicefabric node health", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show node health", "fullName": "servicefabric node health show", "usage": "[options] [nodeName]", "filePath": "commands/servicefabric/serviceFabricNode.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-f --events-health-state-filter ", "required": -33, "optional": 0, "bool": true, "short": "-f", "long": "--events-health-state-filter", "description": "the filter of the event health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "send", "description": "Send node health, Example: azure servicefabric node health send --node-name node1 fabric:app --source-id monitor --property pc --health-state Ok --description healthy", "fullName": "servicefabric node health send", "usage": "[options] [nodeName] [sourceId] [property] [healthState]", "filePath": "commands/servicefabric/serviceFabricNode.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-i --source-id ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--source-id", "description": "the id of the source" }, { "flags": "-p --property ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--property", "description": "the property" }, { "flags": "-e --health-state ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--health-state", "description": "the state of the health, values are [Ok|Warning|Error|Unknown]" }, { "flags": "-d --description ", "required": -18, "optional": 0, "bool": true, "short": "-d", "long": "--description", "description": "the description" }, { "flags": "-m --time-to-live-in-milliseconds ", "required": -35, "optional": 0, "bool": true, "short": "-m", "long": "--time-to-live-in-milliseconds", "description": "the time in milliseconds for live" }, { "flags": "-q --sequence-number ", "required": -22, "optional": 0, "bool": true, "short": "-q", "long": "--sequence-number", "description": "the number of the sequence" }, { "flags": "-w --remove-when-expired", "required": 0, "optional": 0, "bool": true, "short": "-w", "long": "--remove-when-expired", "description": "the boolean of the remove when expired" } ] } ], "categories": {} } } }, "code": { "name": "code", "description": "Commands to manage your code", "fullName": "servicefabric code", "usage": "[options]", "options": [], "commands": [], "categories": { "package": { "name": "package", "description": "Commands to manage your code package", "fullName": "servicefabric code package", "usage": "[options]", "options": [], "commands": [], "categories": { "deployed": { "name": "deployed", "description": "Commands to manage your deployed code package", "fullName": "servicefabric code package deployed", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show deployed application health", "fullName": "servicefabric code package deployed show", "usage": "[options] [nodeName] [applicationName]", "filePath": "commands/servicefabric/serviceFabricPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-a --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--application-name", "description": "the name of the application" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} } } } } }, "service": { "name": "service", "description": "Commands to manage your service", "fullName": "servicefabric service", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show service", "fullName": "servicefabric service show", "usage": "[options] [applicationName]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--service-name", "description": "the name of the service" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "create", "description": "Create service, Example: servicefabric service create --application-name fabric:/app --service-name fabric:/app/service --service-type-name ServiceType1 --service-kind Stateless --instance-count 1 --partition-scheme Singleton", "fullName": "servicefabric service create", "usage": "[options] [applicationName] [serviceName] [serviceTypeName] [serviceKind] [partitionScheme]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--service-name", "description": "the name of the service" }, { "flags": "-t --service-type-name ", "required": -24, "optional": 0, "bool": true, "short": "-t", "long": "--service-type-name", "description": "the name of the service type" }, { "flags": "-k --service-kind ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--service-kind", "description": "the kind of the service, values are [Stateless|Stateful]" }, { "flags": "-c --instance-count ", "required": -21, "optional": 0, "bool": true, "short": "-c", "long": "--instance-count", "description": "the count of the instance" }, { "flags": "-r --target-replica-set-size ", "required": -30, "optional": 0, "bool": true, "short": "-r", "long": "--target-replica-set-size", "description": "the size of the target replica set" }, { "flags": "-m --min-replica-set-size ", "required": -27, "optional": 0, "bool": true, "short": "-m", "long": "--min-replica-set-size", "description": "the size of the min replica set" }, { "flags": "-p --has-persisted-state", "required": 0, "optional": 0, "bool": true, "short": "-p", "long": "--has-persisted-state", "description": "the state of the persisted" }, { "flags": "-a --partition-scheme ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--partition-scheme", "description": "the scheme of the partition" }, { "flags": "-i --partition-count ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--partition-count", "description": "the count of the partition" }, { "flags": "-o --partition-names ", "required": -22, "optional": 0, "bool": true, "short": "-o", "long": "--partition-names", "description": "the names of the partition" }, { "flags": "-l --partition-low-key ", "required": -24, "optional": 0, "bool": true, "short": "-l", "long": "--partition-low-key", "description": "the key of the partition low" }, { "flags": "-g --partition-high-key ", "required": -25, "optional": 0, "bool": true, "short": "-g", "long": "--partition-high-key", "description": "the key of the partition high" }, { "flags": "-b --placement-constraints ", "required": -28, "optional": 0, "bool": true, "short": "-b", "long": "--placement-constraints", "description": "the constraints of the placement" }, { "flags": "-c --correlation-schema ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--correlation-schema", "description": "the schema of the correlation, json string" }, { "flags": "-d --service-load-metrics ", "required": -27, "optional": 0, "bool": true, "short": "-d", "long": "--service-load-metrics", "description": "the metrics of the service load, json string" }, { "flags": "-f --service-placement-policy-description ", "required": -43, "optional": 0, "bool": true, "short": "-f", "long": "--service-placement-policy-description", "description": "the description of the service placement policy, json string" } ] }, { "name": "update", "description": "Update service, Example: azure servicefabric service update --service-name fabric:/app --instance-count 1", "fullName": "servicefabric service update", "usage": "[options] [serviceName] [serviceKind]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the name of the service" }, { "flags": "-k --service-kind ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--service-kind", "description": "the kind of the service, values are [Stateless|Stateful]" }, { "flags": "-c --instance-count ", "required": -21, "optional": 0, "bool": true, "short": "-c", "long": "--instance-count", "description": "the count of the instance" }, { "flags": "-r --target-replica-set-size ", "required": -30, "optional": 0, "bool": true, "short": "-r", "long": "--target-replica-set-size", "description": "the size of the target replica set" }, { "flags": "-m --min-replica-set-size ", "required": -27, "optional": 0, "bool": true, "short": "-m", "long": "--min-replica-set-size", "description": "the size of the min replica set" }, { "flags": "-i --replica-restart-wait-duration-in-milliseconds ", "required": -52, "optional": 0, "bool": true, "short": "-i", "long": "--replica-restart-wait-duration-in-milliseconds", "description": "the milliseconds of the replica restart wait duration" }, { "flags": "-d --quorum-loss-wait-duration-in-milliseconds ", "required": -48, "optional": 0, "bool": true, "short": "-d", "long": "--quorum-loss-wait-duration-in-milliseconds", "description": "the milliseconds of the quorum loss wait duration" }, { "flags": "-t --stand-by-replica-keep-duration-in-milliseconds ", "required": -53, "optional": 0, "bool": true, "short": "-t", "long": "--stand-by-replica-keep-duration-in-milliseconds", "description": "the milliseconds of the stand by replica keep duration" } ] }, { "name": "delete", "description": "Delete service", "fullName": "servicefabric service delete", "usage": "[options] [serviceName]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the name of the service" } ] }, { "name": "resolve", "description": "Resolve service", "fullName": "servicefabric service resolve", "usage": "[options] [serviceName]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the name of the service" }, { "flags": "-t --partition-key-type ", "required": -25, "optional": 0, "bool": true, "short": "-t", "long": "--partition-key-type", "description": "the type of the partition key, values are [Singleton|Int64Range|Named]" }, { "flags": "-k --partition-key-value ", "required": -26, "optional": 0, "bool": true, "short": "-k", "long": "--partition-key-value", "description": "the value of the partition key" }, { "flags": "-r --previous-rsp-version ", "required": -27, "optional": 0, "bool": true, "short": "-r", "long": "--previous-rsp-version", "description": "the version of the previous rsp" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": { "package": { "name": "package", "description": "Commands to send your service package", "fullName": "servicefabric service package", "usage": "[options]", "options": [], "commands": [], "categories": { "deployed": { "name": "deployed", "description": "Commands to send your deployed service package", "fullName": "servicefabric service package deployed", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show deployed service package", "fullName": "servicefabric service package deployed show", "usage": "[options] [nodeName] [applicationName]", "filePath": "commands/servicefabric/serviceFabricPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-a --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--application-name", "description": "the name of the application" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": { "health": { "name": "health", "description": "Commands to manage your deployed service package health", "fullName": "servicefabric service package deployed health", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show deployed service package health", "fullName": "servicefabric service package deployed health show", "usage": "[options] [nodeName] [applicationName] [servicePackageName]", "filePath": "commands/servicefabric/serviceFabricPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-a --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--application-name", "description": "the name of the application" }, { "flags": "-p --service-package-name ", "required": -27, "optional": 0, "bool": true, "short": "-p", "long": "--service-package-name", "description": "the name of the service package" }, { "flags": "-f --events-health-state-filter ", "required": -33, "optional": 0, "bool": true, "short": "-f", "long": "--events-health-state-filter", "description": "the filter of the events health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "send", "description": "Send deployed service package health, Example: azure servicefabric application health send --node-name node1 fabric:app --source-id monitor --property pc --health-state Ok --description healthy", "fullName": "servicefabric service package deployed health send", "usage": "[options] [nodeName] [applicationName] [serviceManifestName] [sourceId] [property] [healthState]", "filePath": "commands/servicefabric/serviceFabricPackage.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-a --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--application-name", "description": "the name of the application" }, { "flags": "-m --service-manifest-name ", "required": -28, "optional": 0, "bool": true, "short": "-m", "long": "--service-manifest-name", "description": "the name of the service manifest" }, { "flags": "-i --source-id ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--source-id", "description": "the id of the source" }, { "flags": "-p --property ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--property", "description": "the property" }, { "flags": "-e --health-state ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--health-state", "description": "the state of the health, values are [Ok|Warning|Error|Unknown]" }, { "flags": "-d --description ", "required": -18, "optional": 0, "bool": true, "short": "-d", "long": "--description", "description": "the description" }, { "flags": "-l --time-to-live-in-milliseconds ", "required": -35, "optional": 0, "bool": true, "short": "-l", "long": "--time-to-live-in-milliseconds", "description": "the time in milliseconds for live" }, { "flags": "-q --sequence-number ", "required": -22, "optional": 0, "bool": true, "short": "-q", "long": "--sequence-number", "description": "the number of the sequence" }, { "flags": "-w --remove-when-expired", "required": 0, "optional": 0, "bool": true, "short": "-w", "long": "--remove-when-expired", "description": "the boolean of the remove when expired" } ] } ], "categories": {} } } } } }, "template": { "name": "template", "description": "Commands to manage your service template", "fullName": "servicefabric service template", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create service from template", "fullName": "servicefabric service template create", "usage": "[options] [applicationName] [serviceName] [serviceTypeName]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--service-name", "description": "the name of the service" }, { "flags": "-t --service-type-name ", "required": -24, "optional": 0, "bool": true, "short": "-t", "long": "--service-type-name", "description": "the name of the service type" } ] } ], "categories": {} }, "type": { "name": "type", "description": "Commands to manage your service manifest", "fullName": "servicefabric service type", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show service type", "fullName": "servicefabric service type show", "usage": "[options] [applicationTypeName] [applicationTypeVersion]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-type-name ", "required": -28, "optional": 0, "bool": true, "short": "-n", "long": "--application-type-name", "description": "the type of the application type" }, { "flags": "-t --application-type-version ", "required": -31, "optional": 0, "bool": true, "short": "-t", "long": "--application-type-version", "description": "the version of the application type" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": { "deployed": { "name": "deployed", "description": "Commands to manage your deployed service type", "fullName": "servicefabric service type deployed", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show deployed service type", "fullName": "servicefabric service type deployed show", "usage": "[options] [nodeName] [applicationName]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-p --service-package-name ", "required": -27, "optional": 0, "bool": true, "short": "-p", "long": "--service-package-name", "description": "the name of the service package" }, { "flags": "-l --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-l", "long": "--application-name", "description": "the name of the application" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} } } }, "manifest": { "name": "manifest", "description": "Commands to manage your service manifest", "fullName": "servicefabric service manifest", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show service manifest", "fullName": "servicefabric service manifest show", "usage": "[options] [applicationTypeName] [applicationTypeVersion] [serviceManifestName]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-type-name ", "required": -28, "optional": 0, "bool": true, "short": "-n", "long": "--application-type-name", "description": "the type of the application type" }, { "flags": "-t --application-type-version ", "required": -31, "optional": 0, "bool": true, "short": "-t", "long": "--application-type-version", "description": "the version of the application type" }, { "flags": "-m --service-manifest-name ", "required": -28, "optional": 0, "bool": true, "short": "-m", "long": "--service-manifest-name", "description": "the name of the service manifest" } ] } ], "categories": {} }, "description": { "name": "description", "description": "Commands to manage your service", "fullName": "servicefabric service description", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show service description", "fullName": "servicefabric service description show", "usage": "[options] [serviceName]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the name of the service" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} }, "health": { "name": "health", "description": "Commands to manage your service", "fullName": "servicefabric service health", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show service health", "fullName": "servicefabric service health show", "usage": "[options] [serviceName]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the name of the service" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "send", "description": "Send service health, Example: azure servicefabric service health send --service-name fabric:/app/svc fabric:app --source-id monitor --property pc --health-state Ok --description healthy", "fullName": "servicefabric service health send", "usage": "[options] [serviceName] [sourceId] [property] [healthState]", "filePath": "commands/servicefabric/serviceFabricService.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the id of the partition" }, { "flags": "-i --source-id ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--source-id", "description": "the id of the source" }, { "flags": "-p --property ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--property", "description": "the property" }, { "flags": "-e --health-state ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--health-state", "description": "the state of the health, values are [Ok|Warning|Error|Unknown]" }, { "flags": "-d --description ", "required": -18, "optional": 0, "bool": true, "short": "-d", "long": "--description", "description": "the description" }, { "flags": "-m --time-to-live-in-milliseconds ", "required": -35, "optional": 0, "bool": true, "short": "-m", "long": "--time-to-live-in-milliseconds", "description": "the time in milliseconds for live" }, { "flags": "-q --sequence-number ", "required": -22, "optional": 0, "bool": true, "short": "-q", "long": "--sequence-number", "description": "the number of the sequence" }, { "flags": "-w --remove-when-expired", "required": 0, "optional": 0, "bool": true, "short": "-w", "long": "--remove-when-expired", "description": "the boolean of the remove when expired" } ] } ], "categories": {} }, "group": { "name": "group", "description": "Commands to manage your service group", "fullName": "servicefabric service group", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create service group, Example: servicefabric service create --application-name fabric:/app --service-name fabric:/app/service --service-type-name ServiceType1 --service-kind Stateless --instance-count 1 --partition-scheme Singleton", "fullName": "servicefabric service group create", "usage": "[options] [applicationName] [serviceName] [serviceTypeName] [serviceKind] [partitionScheme]", "filePath": "commands/servicefabric/serviceFabricServiceGroup.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--service-name", "description": "the name of the service" }, { "flags": "-t --service-type-name ", "required": -24, "optional": 0, "bool": true, "short": "-t", "long": "--service-type-name", "description": "the name of the service type" }, { "flags": "-k --service-kind ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--service-kind", "description": "the kind of the service, values are [Stateless|Stateful]" }, { "flags": "-c --instance-count ", "required": -21, "optional": 0, "bool": true, "short": "-c", "long": "--instance-count", "description": "the count of the instance" }, { "flags": "-r --target-replica-set-size ", "required": -30, "optional": 0, "bool": true, "short": "-r", "long": "--target-replica-set-size", "description": "the size of the target replica set" }, { "flags": "-m --min-replica-set-size ", "required": -27, "optional": 0, "bool": true, "short": "-m", "long": "--min-replica-set-size", "description": "the size of the min replica set" }, { "flags": "-p --has-persisted-state", "required": 0, "optional": 0, "bool": true, "short": "-p", "long": "--has-persisted-state", "description": "the state of the persisted" }, { "flags": "-a --partition-scheme ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--partition-scheme", "description": "the scheme of the partition" }, { "flags": "-t --partition-count ", "required": -22, "optional": 0, "bool": true, "short": "-t", "long": "--partition-count", "description": "the count of the partition" }, { "flags": "-i --partition-names ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--partition-names", "description": "the names of the partition" }, { "flags": "-l --partition-low-key ", "required": -24, "optional": 0, "bool": true, "short": "-l", "long": "--partition-low-key", "description": "the key of the partition low" }, { "flags": "-g --partition-high-key ", "required": -25, "optional": 0, "bool": true, "short": "-g", "long": "--partition-high-key", "description": "the key of the partition high" }, { "flags": "-d --service-group-member-description ", "required": -39, "optional": 0, "bool": true, "short": "-d", "long": "--service-group-member-description", "description": "the description of the service group member" }, { "flags": "-o --placement-constraints ", "required": -28, "optional": 0, "bool": true, "short": "-o", "long": "--placement-constraints", "description": "the constraints of the placement" }, { "flags": "-n --correlation-schema ", "required": -25, "optional": 0, "bool": true, "short": "-n", "long": "--correlation-schema", "description": "the schema of the correlation, json string" }, { "flags": "-a --service-load-metrics ", "required": -27, "optional": 0, "bool": true, "short": "-a", "long": "--service-load-metrics", "description": "the metrics of the service load, json string" }, { "flags": "-y --service-placement-policy-description ", "required": -43, "optional": 0, "bool": true, "short": "-y", "long": "--service-placement-policy-description", "description": "the description of the service placement policy, json string" } ] }, { "name": "update", "description": "Update service group", "fullName": "servicefabric service group update", "usage": "[options] [applicationName] [serviceName] [serviceKind]", "filePath": "commands/servicefabric/serviceFabricServiceGroup.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--service-name", "description": "the name of the service" }, { "flags": "-k --service-kind ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--service-kind", "description": "the kind of the service, values are [Stateless|Stateful]" }, { "flags": "-c --instance-count ", "required": -21, "optional": 0, "bool": true, "short": "-c", "long": "--instance-count", "description": "the count of the instance" }, { "flags": "-r --target-replica-set-size ", "required": -30, "optional": 0, "bool": true, "short": "-r", "long": "--target-replica-set-size", "description": "the size of the target replica set" }, { "flags": "-m --min-replica-set-size ", "required": -27, "optional": 0, "bool": true, "short": "-m", "long": "--min-replica-set-size", "description": "the size of the min replica set" }, { "flags": "-i --replica-restart-wait-duration-in-milliseconds ", "required": -52, "optional": 0, "bool": true, "short": "-i", "long": "--replica-restart-wait-duration-in-milliseconds", "description": "the milliseconds of the replica restart wait duration" }, { "flags": "-d --quorum-loss-wait-duration-in-milliseconds ", "required": -48, "optional": 0, "bool": true, "short": "-d", "long": "--quorum-loss-wait-duration-in-milliseconds", "description": "the milliseconds of the quorum loss wait duration" }, { "flags": "-b --stand-by-replica-keep-duration-in-milliseconds ", "required": -53, "optional": 0, "bool": true, "short": "-b", "long": "--stand-by-replica-keep-duration-in-milliseconds", "description": "the milliseconds of the stand by replica keep duration" } ] }, { "name": "delete", "description": "Delete service group", "fullName": "servicefabric service group delete", "usage": "[options] [applicationName] [serviceName]", "filePath": "commands/servicefabric/serviceFabricServiceGroup.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--service-name", "description": "the name of the service" } ] } ], "categories": { "template": { "name": "template", "description": "Commands to manage your service group template", "fullName": "servicefabric service group template", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create service group from template", "fullName": "servicefabric service group template create", "usage": "[options] [applicationName] [serviceName] [serviceTypeName]", "filePath": "commands/servicefabric/serviceFabricServiceGroup.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--service-name", "description": "the name of the service" }, { "flags": "-t --service-type-name ", "required": -24, "optional": 0, "bool": true, "short": "-t", "long": "--service-type-name", "description": "the name of the service type" } ] } ], "categories": {} }, "description": { "name": "description", "description": "Commands to manage your service group description", "fullName": "servicefabric service group description", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show service group description", "fullName": "servicefabric service group description show", "usage": "[options] [serviceName]", "filePath": "commands/servicefabric/serviceFabricServiceGroup.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the name of the service" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} }, "member": { "name": "member", "description": "Commands to manage your service", "fullName": "servicefabric service group member", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show service group member", "fullName": "servicefabric service group member show", "usage": "[options] [applicationName] [serviceName]", "filePath": "commands/servicefabric/serviceFabricServiceGroup.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-n", "long": "--application-name", "description": "the name of the application" }, { "flags": "-e --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--service-name", "description": "the name of the service" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} } } } } }, "partition": { "name": "partition", "description": "Commands to manage your partition", "fullName": "servicefabric partition", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show partition", "fullName": "servicefabric partition show", "usage": "[options] [serviceName]", "filePath": "commands/servicefabric/serviceFabricPartition.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the name of the service" }, { "flags": "-i --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "repair", "description": "Repair partition", "fullName": "servicefabric partition repair", "usage": "[options]", "filePath": "commands/servicefabric/serviceFabricPartition.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --service-name ", "required": -19, "optional": 0, "bool": true, "short": "-n", "long": "--service-name", "description": "the name of the service" }, { "flags": "-i --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" } ] } ], "categories": { "health": { "name": "health", "description": "Commands to manage your partition health", "fullName": "servicefabric partition health", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show partition health", "fullName": "servicefabric partition health show", "usage": "[options] [partitionId]", "filePath": "commands/servicefabric/serviceFabricPartition.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" }, { "flags": "-f --events-health-state-filter ", "required": -33, "optional": 0, "bool": true, "short": "-f", "long": "--events-health-state-filter", "description": "the filter of the events health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "-r --replicas-health-state-filter ", "required": -35, "optional": 0, "bool": true, "short": "-r", "long": "--replicas-health-state-filter", "description": "the filter of the replicas health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "send", "description": "Send partition health, Example: azure servicefabric partition health send --partition-id 1234 fabric:app --source-id monitor --property pc --health-state Ok --description healthy", "fullName": "servicefabric partition health send", "usage": "[options] [partitionId] [sourceId] [property] [healthState]", "filePath": "commands/servicefabric/serviceFabricPartition.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" }, { "flags": "-o --source-id ", "required": -16, "optional": 0, "bool": true, "short": "-o", "long": "--source-id", "description": "the id of the source" }, { "flags": "-p --property ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--property", "description": "the property" }, { "flags": "-e --health-state ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--health-state", "description": "the state of the health, values are [Ok|Warning|Error|Unknown]" }, { "flags": "-d --description ", "required": -18, "optional": 0, "bool": true, "short": "-d", "long": "--description", "description": "the description" }, { "flags": "-m --time-to-live-in-milliseconds ", "required": -35, "optional": 0, "bool": true, "short": "-m", "long": "--time-to-live-in-milliseconds", "description": "the time in milliseconds for live" }, { "flags": "-n --sequence-number ", "required": -22, "optional": 0, "bool": true, "short": "-n", "long": "--sequence-number", "description": "the number of the sequence" }, { "flags": "-w --remove-when-expired", "required": 0, "optional": 0, "bool": true, "short": "-w", "long": "--remove-when-expired", "description": "the boolean of the remove when expired" } ] } ], "categories": {} }, "load": { "name": "load", "description": "Commands to manage your partition load information", "fullName": "servicefabric partition load", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show partition load information", "fullName": "servicefabric partition load show", "usage": "[options] [partitionId]", "filePath": "commands/servicefabric/serviceFabricPartition.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "reset", "description": "Reset partition", "fullName": "servicefabric partition load reset", "usage": "[options] [partitionId]", "filePath": "commands/servicefabric/serviceFabricPartition.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" } ] } ], "categories": {} } } }, "replica": { "name": "replica", "description": "Commands to manage your replica", "fullName": "servicefabric replica", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show replica", "fullName": "servicefabric replica show", "usage": "[options] [partitionId]", "filePath": "commands/servicefabric/serviceFabricReplica.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" }, { "flags": "-r --replica-id ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--replica-id", "description": "the id of the replica" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": { "deployed": { "name": "deployed", "description": "Commands to manage your deployed replica", "fullName": "servicefabric replica deployed", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show deployed replica", "fullName": "servicefabric replica deployed show", "usage": "[options] [nodeName] [applicationName]", "filePath": "commands/servicefabric/serviceFabricReplica.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-a --application-name ", "required": -23, "optional": 0, "bool": true, "short": "-a", "long": "--application-name", "description": "the name of the application" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "detail", "description": "Show deployed replica detail", "fullName": "servicefabric replica deployed detail", "usage": "[options] [nodeName] [partitionName] [replicaId]", "filePath": "commands/servicefabric/serviceFabricReplica.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --node-name ", "required": -16, "optional": 0, "bool": true, "short": "-n", "long": "--node-name", "description": "the name of the node" }, { "flags": "-p --partition-name ", "required": -21, "optional": 0, "bool": true, "short": "-p", "long": "--partition-name", "description": "the name of the partition" }, { "flags": "-i --replica-id ", "required": -17, "optional": 0, "bool": true, "short": "-i", "long": "--replica-id", "description": "the id of the replica" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "categories": {} }, "health": { "name": "health", "description": "Commands to manage your replica health", "fullName": "servicefabric replica health", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show replica health", "fullName": "servicefabric replica health show", "usage": "[options] [partitionId] [replicaId]", "filePath": "commands/servicefabric/serviceFabricReplica.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" }, { "flags": "-r --replica-id ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--replica-id", "description": "the id of the replicas" }, { "flags": "-f --events-health-state-filter ", "required": -33, "optional": 0, "bool": true, "short": "-f", "long": "--events-health-state-filter", "description": "the filter of the events health state, values are [Default|None|Ok|Warning|Error|All]" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] }, { "name": "send", "description": "Send replica health, Example: azure servicefabric replica health send --partition-id 1234 fabric:app --source-id monitor --property pc --health-state Ok --description healthy", "fullName": "servicefabric replica health send", "usage": "[options] [partitionId] [replicaId] [sourceId] [property] [healthState]", "filePath": "commands/servicefabric/serviceFabricReplica.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" }, { "flags": "-r --replica-id ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--replica-id", "description": "the id of the replica" }, { "flags": "-o --source-id ", "required": -16, "optional": 0, "bool": true, "short": "-o", "long": "--source-id", "description": "the id of the source" }, { "flags": "-p --property ", "required": -15, "optional": 0, "bool": true, "short": "-p", "long": "--property", "description": "the property" }, { "flags": "-e --health-state ", "required": -19, "optional": 0, "bool": true, "short": "-e", "long": "--health-state", "description": "the state of the health, values are [Ok|Warning|Error|Unknown]" }, { "flags": "-d --description ", "required": -18, "optional": 0, "bool": true, "short": "-d", "long": "--description", "description": "the description" }, { "flags": "-m --time-to-live-in-milliseconds ", "required": -35, "optional": 0, "bool": true, "short": "-m", "long": "--time-to-live-in-milliseconds", "description": "the time in milliseconds for live" }, { "flags": "-n --sequence-number ", "required": -22, "optional": 0, "bool": true, "short": "-n", "long": "--sequence-number", "description": "the number of the sequence" }, { "flags": "-w --remove-when-expired", "required": 0, "optional": 0, "bool": true, "short": "-w", "long": "--remove-when-expired", "description": "the boolean of the remove when expired" } ] } ], "categories": {} }, "load": { "name": "load", "description": "Commands to manage your replica load information", "fullName": "servicefabric replica load", "usage": "[options] [command]", "options": [], "commands": [ { "name": "show", "description": "Show replica load information", "fullName": "servicefabric replica load show", "usage": "[options] [partitionId] [replicaId]", "filePath": "commands/servicefabric/serviceFabricReplica.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 --partition-id ", "required": -19, "optional": 0, "bool": true, "short": "-i", "long": "--partition-id", "description": "the id of the partition" }, { "flags": "-r --replica-id ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--replica-id", "description": "the id of the replica" }, { "flags": "--select ", "required": -10, "optional": 0, "bool": true, "long": "--select", "description": "select fields to show, call without this parameter to see all fields" } ] } ], "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. Valid inputs are blob, file or combination of any of them and separated with comma(,)" }, { "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. Valid inputs are blob, file or combination of any of them and separated with comma(,). Only one of --enable-encryption-service and --disable-encryption-service can be set for a service" }, { "flags": "--disable-encryption-service ", "required": -30, "optional": 0, "bool": true, "long": "--disable-encryption-service", "description": "specifies the service which needs to disable encryption settings. Valid inputs are blob, file or combination of any of them and separated with comma(,). Only one of --enable-encryption-service and --disable-encryption-service can be set for a service" }, { "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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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": "--snapshot ", "required": -12, "optional": 0, "bool": true, "long": "--snapshot", "description": "the snapshot timestamp" }, { "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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 timestamp" }, { "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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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. To upload to large block blob, please run on 64-bit machine with 64-bit node.", "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, contentDisposition, contentMD5" }, { "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": "--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": "-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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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": "--snapshot ", "required": -12, "optional": 0, "bool": true, "long": "--snapshot", "description": "the snapshot timestamp" }, { "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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_STORAGE_CONNECTION_STRING]" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": true, "long": "-vv", "description": "run storage command in debug mode" } ] }, { "name": "update", "description": "Update the properties of the specified storage blob", "fullName": "storage blob update", "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": "-p, --properties ", "required": -18, "optional": 0, "bool": true, "short": "-p", "long": "--properties", "description": "the storage blob properties. Properties are key=value pairs and separated with semicolon(;). Available properties are contentType, contentEncoding, contentLanguage, cacheControl, contentDisposition, contentMD5" }, { "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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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. By providing this option, all other source related options will be ignored." }, { "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 timestamp 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": "--incremental", "required": 0, "optional": 0, "bool": true, "long": "--incremental", "description": "whether start page blob incremental copy or not. If yes, the source must be a page blob snapshot. Refer to https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/incremental-copy-blob for more detailed information." }, { "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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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": "--prefix ", "required": -10, "optional": 0, "bool": true, "long": "--prefix", "description": "the storage file name prefix" }, { "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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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": "--concurrenttaskcount ", "required": -23, "optional": 0, "bool": true, "long": "--concurrenttaskcount", "description": "the maximum number of concurrent download requests" }, { "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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 or omit it to use environment variable [AZURE_STORAGE_ACCOUNT]" }, { "flags": "-k, --account-key ", "required": -19, "optional": 0, "bool": true, "short": "-k", "long": "--account-key", "description": "the storage account key or omit it to use environment variable [AZURE_STORAGE_ACCESS_KEY]" }, { "flags": "-c, --connection-string ", "required": -25, "optional": 0, "bool": true, "short": "-c", "long": "--connection-string", "description": "the storage connection string or omit it to use environment variable [AZURE_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 services. ", "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": "Creates or updates a container service.", "fullName": "acs create", "usage": "[options] ", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": "Deletes the specified container service.", "fullName": "acs delete", "usage": "[options] ", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": "Gets the properties of the specified container service.", "fullName": "acs show", "usage": "[options] ", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": "Gets a list of container services in the specified resource group.", "fullName": "acs list", "usage": "[options] ", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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-services in the parameter file.", "fullName": "acs config", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate containerServicesCreateOrUpdate parameter string or files.", "fullName": "acs config create", "usage": "[options]", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 containerServicesCreateOrUpdate parameter JSON file.", "fullName": "acs config patch", "usage": "[options]", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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\":\"\"\r\n },\r\n \"customProfile\":{\r\n \"orchestrator\":\"\"\r\n },\r\n \"servicePrincipalProfile\":{\r\n \"clientId\":\"\",\r\n \"secret\":\"\"\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\":\"\",\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\":false,\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": "--custom-profile ", "required": -18, "optional": 0, "bool": true, "long": "--custom-profile", "description": "Set the custom-profile value." }, { "flags": "--service-principal-profile ", "required": -29, "optional": 0, "bool": true, "long": "--service-principal-profile", "description": "Set the service-principal-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\":\"\"\r\n },\r\n \"customProfile\":{\r\n \"orchestrator\":\"\"\r\n },\r\n \"servicePrincipalProfile\":{\r\n \"clientId\":\"\",\r\n \"secret\":\"\"\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\":\"\",\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\":false,\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": "--custom-profile", "required": 0, "optional": 0, "bool": true, "long": "--custom-profile", "description": "Remove the custom-profile value." }, { "flags": "--service-principal-profile", "required": 0, "optional": 0, "bool": true, "long": "--service-principal-profile", "description": "Remove the service-principal-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\":\"\"\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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\":\"\"\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": {} }, "custom-profile": { "name": "custom-profile", "description": "Commands to configure custom-profile of acs in config file.", "fullName": "acs config custom-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set custom-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"customProfile\" : {\r\n \"orchestrator\":\"\"\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 custom-profile set", "usage": "[options]", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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 ", "required": -16, "optional": 0, "bool": true, "long": "--orchestrator", "description": "Set the orchestrator value." } ] }, { "name": "delete", "description": "Remove custom-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"customProfile\" : {\r\n \"orchestrator\":\"\"\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 custom-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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", "required": 0, "optional": 0, "bool": true, "long": "--orchestrator", "description": "Remove the orchestrator value." } ] } ], "categories": {} }, "service-principal-profile": { "name": "service-principal-profile", "description": "Commands to configure service-principal-profile of acs in config file.", "fullName": "acs config service-principal-profile", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set service-principal-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"servicePrincipalProfile\" : {\r\n \"clientId\":\"\",\r\n \"secret\":\"\"\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 service-principal-profile set", "usage": "[options]", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": "--client-id ", "required": -13, "optional": 0, "bool": true, "long": "--client-id", "description": "Set the client-id value." }, { "flags": "--secret ", "required": -10, "optional": 0, "bool": true, "long": "--secret", "description": "Set the secret value." } ] }, { "name": "delete", "description": "Remove service-principal-profile in config string or files, e.g. \r\n {\r\n ...\r\n \"servicePrincipalProfile\" : {\r\n \"clientId\":\"\",\r\n \"secret\":\"\"\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 service-principal-profile delete", "usage": "[options]", "filePath": "commands/arm/compute/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": "--client-id", "required": 0, "optional": 0, "bool": true, "long": "--client-id", "description": "Remove the client-id value." }, { "flags": "--secret", "required": 0, "optional": 0, "bool": true, "long": "--secret", "description": "Remove the secret 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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\":\"\",\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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\":\"\",\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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\":false,\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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\":false,\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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\":false,\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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\":false,\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/containerServices.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": "-i --identifier-uris ", "required": -22, "optional": 0, "bool": true, "short": "-i", "long": "--identifier-uris", "description": "the comma-delimitied URIs that identify the application" }, { "flags": "-l --available ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--available", "description": "the value specifying whether the application is a single tenant or a multi-tenant. \"true\" if the application will be available to other tenants, \"false\" if its a single tenant application. Default is false." }, { "flags": "-r --reply-urls ", "required": -17, "optional": 0, "bool": true, "short": "-r", "long": "--reply-urls", "description": "the comma-delimitied application reply urls" }, { "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": "--cert-value ", "required": -14, "optional": 0, "bool": true, "long": "--cert-value", "description": "the value of the \"asymmetric\" credential type. It represents the base 64 encoded certificate." }, { "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": "-l --available ", "required": -16, "optional": 0, "bool": true, "short": "-l", "long": "--available", "description": "the new value specifying whether the application is a single tenant or a multi-tenant. \"true\" if the application will be available to other tenants, \"false\" if its a single tenant application." }, { "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": "-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": "-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": "--cert-value ", "required": -14, "optional": 0, "bool": true, "long": "--cert-value", "description": "new value of the \"asymmetric\" credential type. It represents the base 64 encoded certificate." }, { "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. When --json flag is used, it will get the information from all the pages and then provide the final json array.", "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. When --json flag is used, it will get the information from all the pages and then provide the final json array.", "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." }, { "flags": "| more", "required": 0, "optional": 0, "bool": true, "short": "", "long": "more", "description": "Provides paging support. Press 'Enter' for more information." } ] }, { "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. When --json flag is used, it will get the information from all the pages and then provide the final json array.", "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": "-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": "--cert-value ", "required": -14, "optional": 0, "bool": true, "long": "--cert-value", "description": "the value of the \"asymmetric\" credential type. It represents the base 64 encoded certificate" }, { "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": "-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": "--cert-value ", "required": -14, "optional": 0, "bool": true, "long": "--cert-value", "description": "new value of the \"asymmetric\" credential type. It represents the base 64 encoded certificate" }, { "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": "-d --delete-application", "required": 0, "optional": 0, "bool": true, "short": "-d", "long": "--delete-application", "description": "Default value: false. If you 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. When --json flag is used, it will get the information from all the pages and then provide the final json array.", "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": {} } } } } }, "appserviceplan": { "name": "appserviceplan", "description": "Commands to manage your Azure appserviceplans", "fullName": "appserviceplan", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Create an App Service Plan", "fullName": "appserviceplan create", "usage": "[options] ", "filePath": "commands/arm/appserviceplan/appserviceplan.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": -21, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "Name of the resource group" }, { "flags": "-n --name ", "required": -11, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the name of the App Service Plan to create" }, { "flags": "-l --location ", "required": -15, "optional": 0, "bool": true, "short": "-l", "long": "--location", "description": "the geographic region to create the App Service Plan, \n\t\t\t\t\t locations found at https://azure.microsoft.com/en-us/status/" }, { "flags": "-k --sku ", "required": -10, "optional": 0, "bool": true, "short": "-k", "long": "--sku", "description": "sku of the App Service Plan\n\teg:\n\t\t F1 (Free), D1 (Shared),\n\t\t B1 (Basic Small), B2 (Basic Medium), B3 (Basic Large),\n\t\t S1 (Standard Small), S2 (Standard Medium), S3 (Standard Large),\n\t\t P1 (Premium Small), P2 (Premium Medium), P3 (Premium Large)\n" }, { "flags": "-i --instances ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--instances", "description": "the number of instances in the App Service Plan, Default is 1" }, { "flags": "-x --islinux ", "required": -14, "optional": 0, "bool": true, "short": "-x", "long": "--islinux", "description": "enables a linux App Service Plan, E.g --islinux true" }, { "flags": "-s --subscription ", "required": -19, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" }, { "flags": "-t --tier ", "required": -11, "optional": 0, "bool": true, "short": "-t", "long": "--tier", "description": "to be deprecated, please use --sku option" } ] }, { "name": "delete", "description": "Delete an App Service Plan", "fullName": "appserviceplan delete", "usage": "[options] ", "filePath": "commands/arm/appserviceplan/appserviceplan.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": -21, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "Name of the resource group" }, { "flags": "-n --name ", "required": -11, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the name of the App Service Plan to delete" }, { "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": -19, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "list", "description": "List your App Service Plans", "fullName": "appserviceplan list", "usage": "[options] ", "filePath": "commands/arm/appserviceplan/appserviceplan.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": -21, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the name of the resource group" }, { "flags": "-s --subscription ", "required": -19, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "show", "description": "Get an App Service Plan", "fullName": "appserviceplan show", "usage": "[options] ", "filePath": "commands/arm/appserviceplan/appserviceplan.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": -21, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "the name of the resource group" }, { "flags": "-n --name ", "required": -11, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the name of the App Service Plan to show" }, { "flags": "-s --subscription ", "required": -19, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" } ] }, { "name": "set", "description": "Update App Service Plan Configurations", "fullName": "appserviceplan set", "usage": "[options] ", "filePath": "commands/arm/appserviceplan/appserviceplan.js", "options": [ { "flags": "-v, --verbose", "required": 0, "optional": 0, "bool": true, "short": "-v", "long": "--verbose", "description": "use verbose output" }, { "flags": "-vv", "required": 0, "optional": 0, "bool": 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": -21, "optional": 0, "bool": true, "short": "-g", "long": "--resource-group", "description": "Name of the resource group" }, { "flags": "-n --name ", "required": -11, "optional": 0, "bool": true, "short": "-n", "long": "--name", "description": "the name of the App Service Plan to update" }, { "flags": "-k --sku ", "required": -10, "optional": 0, "bool": true, "short": "-k", "long": "--sku", "description": "sku of the App Service Plan\n\teg:\n\t\t F1 (Free), D1 (Shared),\n\t\t B1 (Basic Small), B2 (Basic Medium), B3 (Basic Large),\n\t\t S1 (Standard Small), S2 (Standard Medium), S3 (Standard Large),\n\t\t P1 (Premium Small), P2 (Premium Medium), P3 (Premium Large)\n" }, { "flags": "-i --instances ", "required": -16, "optional": 0, "bool": true, "short": "-i", "long": "--instances", "description": "the number of instances in the App Service Plan, Default is 1" }, { "flags": "-s --subscription ", "required": -19, "optional": 0, "bool": true, "short": "-s", "long": "--subscription", "description": "the subscription identifier" }, { "flags": "-t --tier ", "required": -11, "optional": 0, "bool": true, "short": "-t", "long": "--tier", "description": "to be deprecated, please use --sku option" } ] } ], "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": "create-or-update", "description": "Create or update an availability set.", "fullName": "availset create-or-update", "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": "-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": "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": { "config": { "name": "config", "description": "Commands to manage configuration of availability-sets in the parameter file.", "fullName": "availset config", "usage": "[options] [command]", "options": [], "commands": [ { "name": "create", "description": "Generate availabilitySetsCreateOrUpdate parameter string or files.", "fullName": "availset config create", "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": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." } ] }, { "name": "patch", "description": "Command to patch availabilitySetsCreateOrUpdate parameter JSON file.", "fullName": "availset config patch", "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": "--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": { "availability-set": { "name": "availability-set", "description": "Commands to configure availability-set of availset in config file.", "fullName": "availset config availability-set", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set availability-set in config string or files, e.g. \r\n{\r\n \"platformUpdateDomainCount\":null,\r\n \"platformFaultDomainCount\":null,\r\n \"virtualMachines\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"statuses\":[\r\n {\r\n \"code\":\"\",\r\n \"level\":null,\r\n \"displayStatus\":\"\",\r\n \"message\":\"\",\r\n \"time\":null\r\n }\r\n ],\r\n \"sku\":{\r\n \"name\":\"\",\r\n \"tier\":\"\",\r\n \"capacity\":null\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": "availset config availability-set set", "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": "--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": "--platform-update-domain-count ", "required": -32, "optional": 0, "bool": true, "long": "--platform-update-domain-count", "description": "Set the platform-update-domain-count value." }, { "flags": "--platform-fault-domain-count ", "required": -31, "optional": 0, "bool": true, "long": "--platform-fault-domain-count", "description": "Set the platform-fault-domain-count value." }, { "flags": "--virtual-machines ", "required": -20, "optional": 0, "bool": true, "long": "--virtual-machines", "description": "Set the virtual-machines value." }, { "flags": "--statuses ", "required": -12, "optional": 0, "bool": true, "long": "--statuses", "description": "Set the statuses value." }, { "flags": "--sku ", "required": -7, "optional": 0, "bool": true, "long": "--sku", "description": "Set the sku 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 availability-set in config string or files, e.g. \r\n{\r\n \"platformUpdateDomainCount\":null,\r\n \"platformFaultDomainCount\":null,\r\n \"virtualMachines\":[\r\n {\r\n \"id\":\"\"\r\n }\r\n ],\r\n \"statuses\":[\r\n {\r\n \"code\":\"\",\r\n \"level\":null,\r\n \"displayStatus\":\"\",\r\n \"message\":\"\",\r\n \"time\":null\r\n }\r\n ],\r\n \"sku\":{\r\n \"name\":\"\",\r\n \"tier\":\"\",\r\n \"capacity\":null\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": "availset config availability-set delete", "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": "--parameter-file ", "required": -18, "optional": 0, "bool": true, "long": "--parameter-file", "description": "The parameter file path." }, { "flags": "--platform-update-domain-count", "required": 0, "optional": 0, "bool": true, "long": "--platform-update-domain-count", "description": "Remove the platform-update-domain-count value." }, { "flags": "--platform-fault-domain-count", "required": 0, "optional": 0, "bool": true, "long": "--platform-fault-domain-count", "description": "Remove the platform-fault-domain-count value." }, { "flags": "--virtual-machines", "required": 0, "optional": 0, "bool": true, "long": "--virtual-machines", "description": "Remove the virtual-machines value." }, { "flags": "--statuses", "required": 0, "optional": 0, "bool": true, "long": "--statuses", "description": "Remove the statuses value." }, { "flags": "--sku", "required": 0, "optional": 0, "bool": true, "long": "--sku", "description": "Remove the sku 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": {} }, "virtual-machines": { "name": "virtual-machines", "description": "Commands to configure virtual-machines of availset in config file.", "fullName": "availset config virtual-machines", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set virtual-machines in config string or files, e.g. \r\n {\r\n ...\r\n \"virtualMachines\" : {\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": "availset config virtual-machines set", "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": "--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": "--id ", "required": -6, "optional": 0, "bool": true, "long": "--id", "description": "Set the id value." } ] }, { "name": "delete", "description": "Remove virtual-machines in config string or files, e.g. \r\n {\r\n ...\r\n \"virtualMachines\" : {\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": "availset config virtual-machines delete", "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": "--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": "--id", "required": 0, "optional": 0, "bool": true, "long": "--id", "description": "Remove the id value." } ] } ], "categories": {} }, "statuses": { "name": "statuses", "description": "Commands to configure statuses of availset in config file.", "fullName": "availset config statuses", "usage": "[options] [command]", "options": [], "commands": [ { "name": "set", "description": "Set statuses in config string or files, e.g. \r\n {\r\n ...\r\n \"statuses\" : {\r\n \"code\":\"\",\r\n \"level\":null,\r\n \"displayStatus\":\"\",\r\n \"message\":\"\",\r\n \"time\":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": "availset config statuses set", "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": "--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": "--code ", "required": -8, "optional": 0, "bool": true, "long": "--code", "description": "Set the code value." }, { "flags": "--level ", "required": -9, "optional": 0, "bool": true, "long": "--level", "description": "Set the level value." }, { "flags": "--display-status ", "required": -18, "optional": 0, "bool": true, "long": "--display-status", "description": "Set the display-status value." }, { "flags": "--message ", "required": -11, "optional": 0, "bool": true, "long": "--message", "description": "Set the message value." }, { "flags": "--time