How to use the knack.help_files.helps function in knack

To help you get started, we’ve selected a few knack examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github Azure / azure-cli / src / azure-cli / azure / cli / command_modules / lab / _help.py View on Github external
- name: --artifact-source-name
    short-summary: Name of the artifact source in the lab.
    populator-commands:
      - az lab artifact-source list
  - name: --parameters
    short-summary: JSON encoded list of parameters. Use '@{file}' to load from a file.
  - name: --tags
    short-summary: The tags for the resource.
"""

helps['lab environment delete'] = """
type: command
short-summary: Delete an environment from a lab.
"""

helps['lab environment list'] = """
type: command
short-summary: List environments in a lab.
examples:
  - name: List environments in a lab. (autogenerated)
    text: az lab environment list --lab-name MyLab --resource-group MyResourceGroup
    crafted: true
"""

helps['lab environment show'] = """
type: command
short-summary: Get the details for an environment of a lab.
"""

helps['lab formula'] = """
type: group
short-summary: Manage formulas for an Azure DevTest Lab.
github microsoft / service-fabric-cli / src / sfctl / helps / app_type.py View on Github external
# -----------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# -----------------------------------------------------------------------------

"""Help documentation for Service Fabric application and compose commands."""

from knack.help_files import helps

helps['application provision'] = """
    type: command
github Azure / azure-cli-extensions / src / codespaces / azext_codespaces / _help.py View on Github external
text: az codespace plan create -g my-rg -n my-plan --default-suspend-after 120
        - name: Create a plan associated with a subnet
          text: az codespace plan create -g my-rg -n my-plan --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/default
"""

helps['codespace plan list'] = """
    type: command
    short-summary: List Codespace plans.
    examples:
        - name: List plans
          text: az codespace plan list
        - name: List plans in a given resource group
          text: az codespace plan list -g my-rg
"""

helps['codespace plan delete'] = """
    type: command
    short-summary: Delete a Codespace plan.
    examples:
        - name: Delete a plan
          text: az codespace plan delete -g my-rg -n my-plan
"""

helps['codespace plan show'] = """
    type: command
    short-summary: Show details of a Codespace plan.
    examples:
        - name: Show details of a plan
          text: az codespace plan show -g my-rg -n my-plan
"""

helps['codespace create'] = """
github Azure / azure-cli / src / azure-cli / azure / cli / command_modules / billing / _help.py View on Github external
# coding=utf-8
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

from knack.help_files import helps  # pylint: disable=unused-import
# pylint: disable=line-too-long, too-many-lines

helps['billing'] = """
type: group
short-summary: Manage Azure Billing.
"""

helps['billing enrollment-account'] = """
type: group
short-summary: Get enrollment accounts.
"""

helps['billing invoice'] = """
type: group
short-summary: Get billing invoices for a subscription.
"""

helps['billing period'] = """
type: group
github Azure / azure-cli-extensions / src / databricks / azext_databricks / _help.py View on Github external
az databricks workspace show --resource-group MyResourceGroup --name MyWorkspace
"""

helps['databricks workspace list'] = """
    type: command
    short-summary: Get all the workspaces.
    examples:
      - name: List workspaces within a resource group
        text: |-
               az databricks workspace list --resource-group MyResourceGroup
      - name: List workspaces within the default subscription
        text: |-
               az databricks workspace list
"""

helps['databricks workspace wait'] = """
    type: command
    short-summary: Place the CLI in a waiting state until a condition of the Databricks workspace is met.
    examples:
        - name: Pause executing next line of CLI script until the Databricks workspace is successfully provisioned.
          text: az databricks workspace wait --resource-group MyResourceGroup --name MyWorkspace \\
                --created
"""

helps['databricks workspace vnet-peering'] = """
    type: group
    short-summary: Commands to manage databricks workspace vnet peering.
"""

helps['databricks workspace vnet-peering create'] = """
    type: command
    short-summary: Create a vnet peering for a workspace.
github Azure / azure-cli / src / azure-cli / azure / cli / command_modules / cloud / _help.py View on Github external
# coding=utf-8
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

from knack.help_files import helps  # pylint: disable=unused-import
# pylint: disable=line-too-long, too-many-lines

helps['cloud'] = """
type: group
short-summary: Manage registered Azure clouds.
"""

helps['cloud list'] = """
type: command
short-summary: List registered clouds.
"""

helps['cloud list-profiles'] = """
type: command
short-summary: List the supported profiles for a cloud.
"""

helps['cloud register'] = """
type: command
short-summary: Register a cloud.
long-summary: When registering a cloud, specify only the resource manager endpoint for the autodetection of other endpoints.
"""

helps['cloud set'] = """
github Azure / azure-cli / src / azure-cli / azure / cli / command_modules / container / _help.py View on Github external
"""

helps['container export'] = """
type: command
short-summary: Export a container group in yaml format.
examples:
  - name: Export a container group in yaml.
    text: az container export -g MyResourceGroup --name mynginx -f output.yaml
"""

helps['container list'] = """
type: command
short-summary: List container groups.
"""

helps['container logs'] = """
type: command
short-summary: Examine the logs for a container in a container group.
examples:
  - name: Examine the logs for a container in a container group. (autogenerated)
    text: az container logs --name MyContainerGroup --resource-group MyResourceGroup
    crafted: true
"""

helps['container show'] = """
type: command
github Azure / azure-cli-extensions / src / db-up / azext_db_up / _help.py View on Github external
text: az mysql down
        - name: Delete the resource group and the full cache.
          text: az mysql down --delete-group
"""

helps['postgres down'] = """
    type: command
    short-summary: Delete the PostgreSQL server and its cached information.
    examples:
        - name: Delete the server and the cached data, aside from the resource group.
          text: az postgres down
        - name: Delete the resource group and the full cache.
          text: az postgres down --delete-group
"""

helps['sql down'] = """
    type: command
    short-summary: Delete the SQL server and its cached information.
    examples:
        - name: Delete the server and the cached data, aside from the resource group.
          text: az sql down
        - name: Delete the resource group and the full cache.
          text: az sql down --delete-group
"""

helps['mysql show-connection-string'] = """
    type: command
    short-summary: Show the connection strings for a MySQL server database.
"""

helps['postgres show-connection-string'] = """
    type: command
github microsoft / PowerPlatformConnectors / tools / paconn-cli / paconn / commands / help.py View on Github external
from paconn import _COMMAND_GROUP, _LOGIN, _DOWNLOAD, _CREATE, _UPDATE, _VALIDATE

helps[_COMMAND_GROUP] = """
    short-summary: Microsoft Power Platform Connectors CLI
"""

helps[_LOGIN] = """
    type: command
    short-summary: Login to Power Platform.
    examples:
        - name: Login
          text: paconn login
"""


helps[_DOWNLOAD] = """
    type: command
    short-summary: Downloads a given custom connector to the local directory.
    examples:
        - name: Download connector
          text: paconn download
"""

helps[_CREATE] = """
    type: command
    short-summary: Creates a new custom connector from the given directory.
    examples:
        - name: Create connector
          text: paconn create
"""

helps[_UPDATE] = """
github Azure / azure-cli-extensions / src / eventgrid / azext_eventgrid / _help.py View on Github external
examples:
  - name: List all event-channels in a specific partner namespace.
    text: az eventgrid partner namespace event-channel list -g rg1 --partner-namespace-name partnernamespace1
  - name: List all event channel under a partner namespace whose name contains the pattern "XYZ"
    text: az eventgrid partner namespace event-channel list -g rg1 --partner-namespace-name partnernamespace1  --odata-query "Contains(name, 'XYZ')"
"""

helps['eventgrid partner namespace event-channel delete'] = """
type: command
short-summary: Delete a partner namespace.
examples:
  - name: Delete a specific partner namespace.
    text: az eventgrid partner namespace event-channel delete -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1
"""

helps['eventgrid partner namespace event-channel show'] = """
type: command
short-summary: Get the details of an event channel under a partner namespace.
examples:
  - name: Show the details of an event channel.
    text: az eventgrid partner namespace event-channel show -g rg1 --partner-namespace-name partnernamespace1 -n eventChannelName1
  - name: Show the details of an event-channel based on resource ID.
    text: az eventgrid partner namespace event-channel show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/partnenamespaces/partnernamespace1/eventChannels/eventChannelName1
"""


helps['eventgrid partner topic'] = """
type: group
short-summary: Manage partner topics.
"""

helps['eventgrid system-topic'] = """