<filename>src/webpubsub/azext_webpubsub/_help.py<gh_stars>0
# 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


helps['webpubsub'] = """
    type: group
    short-summary: Commands to manage Webpubsub.
"""

helps['webpubsub key'] = """
    type: group
    short-summary: Commands to manage Webpubsub keys.
"""

helps['webpubsub hub'] = """
    type: group
    short-summary: Commands to manage Webpubsub hub settings.
"""

helps['webpubsub network-rule'] = """
    type: group
    short-summary: Commands to manage Webpubsub network rules.
"""

helps['webpubsub client'] = """
    type: group
    short-summary: Commands to manage client connections.
"""

helps['webpubsub service'] = """
    type: group
    short-summary: Commands to manage Webpubsub service.
"""

helps['webpubsub service connection'] = """
    type: group
    short-summary: Commands to manage Webpubsub service connections.
"""

helps['webpubsub service user'] = """
    type: group
    short-summary: Commands to manage Webpubsub service users.
"""

helps['webpubsub service group'] = """
    type: group
    short-summary: Commands to manage Webpubsub service groups.
"""

helps['webpubsub service permission'] = """
    type: group
    short-summary: Commands to manage Webpubsub service permissions.
"""

helps['webpubsub create'] = """
    type: command
    short-summary: Create a Webpubsub.
    examples:
      - name: Create a WebPubSub Service with Standard SKU and unit 2.
        text: >
          az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2
"""

helps['webpubsub list'] = """
    type: command
    short-summary: List Webpubsub.
"""

helps['webpubsub delete'] = """
    type: command
    short-summary: Delete a Webpubsub.
"""

helps['webpubsub show'] = """
    type: command
    short-summary: Show details of a Webpubsub.
"""

helps['webpubsub update'] = """
    type: command
    short-summary: Update a Webpubsub.
    examples:
      - name: Update a WebPubSub Service to unit 10.
        text: >
          az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10
"""

helps['webpubsub restart'] = """
    type: command
    short-summary: Restart a Webpubsub.
"""

helps['webpubsub key show'] = """
    type: command
    short-summary: Show connetion strings and keys for a WebPubSub Service
    examples:
      - name: Get the primary key for a WebPubSub Service.
        text: >
          az webpubsub key show -n MyWebPubSub -g MyResourceGroup --query primaryKey -o tsv
"""

helps['webpubsub key regenerate'] = """
    type: command
    short-summary: Regenerate keys for a WebPubSub Service
    examples:
      - name: Regenerate the primary key for a WebPubSub Service.
        text: >
          az webpubsub key regenerate -n MyWebPubSub -g MyResourceGroup --key-type primary --query primaryKey -o tsv
"""

helps['webpubsub network-rule show'] = """
    type: command
    short-summary: Get the Network access control of WebPubSub Service.
"""

helps['webpubsub network-rule update'] = """
    type: command
    short-summary: Update the Network access control of WebPubSub Service.
    examples:
      - name: Set allowing RESTAPI only for public network.
        text: >
            az webpubsub network-rule update --public-network -n MyWebPubSub -g MyResourceGroup --allow RESTAPI
      - name: Set allowing client connection and server connection for a private endpoint connection
        text: >
            az webpubsub network-rule update --connection-name MyPrivateEndpointConnection -n MyWebPubSub -g MyResourceGroup --allow ClientConnection ServerConnection
      - name: Set denying client connection for both public network and private endpoint connections
        text: >
            az webpubsub network-rule update --public-network --connection-name MyPrivateEndpointConnection1 MyPrivateEndpointConnection2 -n MyWebPubSub -g MyResourceGroup --deny ClientConnection
"""

helps['webpubsub hub show'] = """
    type: command
    short-summary: Show hub settings for WebPubSub Service.
"""

helps['webpubsub hub list'] = """
    type: command
    short-summary: List all hub settings for WebPubSub Service.
"""

helps['webpubsub hub delete'] = """
    type: command
    short-summary: Delete hub settings for WebPubSub Service.
"""

helps['webpubsub hub create'] = """
    type: command
    short-summary: Create hub settings for WebPubSub Service.
    examples:
      - name: Create a hub setting with two event handler settings
        text: >
            az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
      - name: Create a hub setting with anonymous connection allowed
        text: >
            az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
"""

helps['webpubsub hub update'] = """
    type: command
    short-summary: Update hub settings for WebPubSub Service.
    examples:
      - name: Update event handler settings of a hub
        text: >
            az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
      - name: Update to allow anonymous connection
        text: >
            az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
"""

helps['webpubsub client start'] = """
    type: command
    short-summary: Start a interactive client connection.
"""

helps['webpubsub service broadcast'] = """
    type: command
    short-summary: Broadcast messages to hub.
    examples:
      - name: Send a message to hub
        text: >
            az webpubsub service broadcast -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --payload MyPayload
"""

helps['webpubsub service connection exist'] = """
    type: command
    short-summary: Check whether client connection exists
"""

helps['webpubsub service connection close'] = """
    type: command
    short-summary: Close a specific client connection
"""

helps['webpubsub service connection send'] = """
    type: command
    short-summary: Send a message to connection
"""

helps['webpubsub service group add-connection'] = """
    type: command
    short-summary: Add a connection to group
"""

helps['webpubsub service group remove-connection'] = """
    type: command
    short-summary: Remove a connection from group
"""

helps['webpubsub service group add-user'] = """
    type: command
    short-summary: Add a user to group
"""

helps['webpubsub service group remove-user'] = """
    type: command
    short-summary: Remove a user from group
"""

helps['webpubsub service group send'] = """
    type: command
    short-summary: Send a message to group
"""

helps['webpubsub service user send'] = """
    type: command
    short-summary: Send a message to user
"""

helps['webpubsub service user exist'] = """
    type: command
    short-summary: Check if there are any client connections connected for the given user
"""

helps['webpubsub service permission grant'] = """
    type: command
    short-summary: Grant a group permission to the connection.
"""

helps['webpubsub service permission revoke'] = """
    type: command
    short-summary: Revoke a group permission from the connection.
"""

helps['webpubsub service permission check'] = """
    type: command
    short-summary: Check if a connection has permission to the specified group
"""

<filename>src/webpubsub/azext_webpubsub/_help.py<gh_stars>0
# 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


helps['webpubsub'] = """
    type: group
    short-summary: Commands to manage Webpubsub.
"""

helps['webpubsub key'] = """
    type: group
    short-summary: Commands to manage Webpubsub keys.
"""

helps['webpubsub hub'] = """
    type: group
    short-summary: Commands to manage Webpubsub hub settings.
"""

helps['webpubsub network-rule'] = """
    type: group
    short-summary: Commands to manage Webpubsub network rules.
"""

helps['webpubsub client'] = """
    type: group
    short-summary: Commands to manage client connections.
"""

helps['webpubsub service'] = """
    type: group
    short-summary: Commands to manage Webpubsub service.
"""

helps['webpubsub service connection'] = """
    type: group
    short-summary: Commands to manage Webpubsub service connections.
"""

helps['webpubsub service user'] = """
    type: group
    short-summary: Commands to manage Webpubsub service users.
"""

helps['webpubsub service group'] = """
    type: group
    short-summary: Commands to manage Webpubsub service groups.
"""

helps['webpubsub service permission'] = """
    type: group
    short-summary: Commands to manage Webpubsub service permissions.
"""

helps['webpubsub create'] = """
    type: command
    short-summary: Create a Webpubsub.
    examples:
      - name: Create a WebPubSub Service with Standard SKU and unit 2.
        text: >
          az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2
"""

helps['webpubsub list'] = """
    type: command
    short-summary: List Webpubsub.
"""

helps['webpubsub delete'] = """
    type: command
    short-summary: Delete a Webpubsub.
"""

helps['webpubsub show'] = """
    type: command
    short-summary: Show details of a Webpubsub.
"""

helps['webpubsub update'] = """
    type: command
    short-summary: Update a Webpubsub.
    examples:
      - name: Update a WebPubSub Service to unit 10.
        text: >
          az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10
"""

helps['webpubsub restart'] = """
    type: command
    short-summary: Restart a Webpubsub.
"""

helps['webpubsub key show'] = """
    type: command
    short-summary: Show connetion strings and keys for a WebPubSub Service
    examples:
      - name: Get the primary key for a WebPubSub Service.
        text: >
          az webpubsub key show -n MyWebPubSub -g MyResourceGroup --query primaryKey -o tsv
"""

helps['webpubsub key regenerate'] = """
    type: command
    short-summary: Regenerate keys for a WebPubSub Service
    examples:
      - name: Regenerate the primary key for a WebPubSub Service.
        text: >
          az webpubsub key regenerate -n MyWebPubSub -g MyResourceGroup --key-type primary --query primaryKey -o tsv
"""

helps['webpubsub network-rule show'] = """
    type: command
    short-summary: Get the Network access control of WebPubSub Service.
"""

helps['webpubsub network-rule update'] = """
    type: command
    short-summary: Update the Network access control of WebPubSub Service.
    examples:
      - name: Set allowing RESTAPI only for public network.
        text: >
            az webpubsub network-rule update --public-network -n MyWebPubSub -g MyResourceGroup --allow RESTAPI
      - name: Set allowing client connection and server connection for a private endpoint connection
        text: >
            az webpubsub network-rule update --connection-name MyPrivateEndpointConnection -n MyWebPubSub -g MyResourceGroup --allow ClientConnection ServerConnection
      - name: Set denying client connection for both public network and private endpoint connections
        text: >
            az webpubsub network-rule update --public-network --connection-name MyPrivateEndpointConnection1 MyPrivateEndpointConnection2 -n MyWebPubSub -g MyResourceGroup --deny ClientConnection
"""

helps['webpubsub hub show'] = """
    type: command
    short-summary: Show hub settings for WebPubSub Service.
"""

helps['webpubsub hub list'] = """
    type: command
    short-summary: List all hub settings for WebPubSub Service.
"""

helps['webpubsub hub delete'] = """
    type: command
    short-summary: Delete hub settings for WebPubSub Service.
"""

helps['webpubsub hub create'] = """
    type: command
    short-summary: Create hub settings for WebPubSub Service.
    examples:
      - name: Create a hub setting with two event handler settings
        text: >
            az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
      - name: Create a hub setting with anonymous connection allowed
        text: >
            az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
"""

helps['webpubsub hub update'] = """
    type: command
    short-summary: Update hub settings for WebPubSub Service.
    examples:
      - name: Update event handler settings of a hub
        text: >
            az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
      - name: Update to allow anonymous connection
        text: >
            az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
"""

helps['webpubsub client start'] = """
    type: command
    short-summary: Start a interactive client connection.
"""

helps['webpubsub service broadcast'] = """
    type: command
    short-summary: Broadcast messages to hub.
    examples:
      - name: Send a message to hub
        text: >
            az webpubsub service broadcast -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --payload MyPayload
"""

helps['webpubsub service connection exist'] = """
    type: command
    short-summary: Check whether client connection exists
"""

helps['webpubsub service connection close'] = """
    type: command
    short-summary: Close a specific client connection
"""

helps['webpubsub service connection send'] = """
    type: command
    short-summary: Send a message to connection
"""

helps['webpubsub service group add-connection'] = """
    type: command
    short-summary: Add a connection to group
"""

helps['webpubsub service group remove-connection'] = """
    type: command
    short-summary: Remove a connection from group
"""

helps['webpubsub service group add-user'] = """
    type: command
    short-summary: Add a user to group
"""

helps['webpubsub service group remove-user'] = """
    type: command
    short-summary: Remove a user from group
"""

helps['webpubsub service group send'] = """
    type: command
    short-summary: Send a message to group
"""

helps['webpubsub service user send'] = """
    type: command
    short-summary: Send a message to user
"""

helps['webpubsub service user exist'] = """
    type: command
    short-summary: Check if there are any client connections connected for the given user
"""

helps['webpubsub service permission grant'] = """
    type: command
    short-summary: Grant a group permission to the connection.
"""

helps['webpubsub service permission revoke'] = """
    type: command
    short-summary: Revoke a group permission from the connection.
"""

helps['webpubsub service permission check'] = """
    type: command
    short-summary: Check if a connection has permission to the specified group
"""

# 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. # -------------------------------------------------------------------------------------------- # pylint: disable=unused-import type: group     short-summary: Commands to manage Webpubsub. type: group     short-summary: Commands to manage Webpubsub keys. type: group     short-summary: Commands to manage Webpubsub hub settings. type: group     short-summary: Commands to manage Webpubsub network rules. type: group     short-summary: Commands to manage client connections. type: group     short-summary: Commands to manage Webpubsub service. type: group     short-summary: Commands to manage Webpubsub service connections. type: group     short-summary: Commands to manage Webpubsub service users. type: group     short-summary: Commands to manage Webpubsub service groups. type: group     short-summary: Commands to manage Webpubsub service permissions. type: command     short-summary: Create a Webpubsub.     examples:       - name: Create a WebPubSub Service with Standard SKU and unit 2.         text: >           az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2 type: command     short-summary: List Webpubsub. type: command     short-summary: Delete a Webpubsub. type: command     short-summary: Show details of a Webpubsub. type: command     short-summary: Update a Webpubsub.     examples:       - name: Update a WebPubSub Service to unit 10.         text: >           az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10 type: command     short-summary: Restart a Webpubsub. type: command     short-summary: Show connetion strings and keys for a WebPubSub Service     examples:       - name: Get the primary key for a WebPubSub Service.         text: >           az webpubsub key show -n MyWebPubSub -g MyResourceGroup --query primaryKey -o tsv type: command     short-summary: Regenerate keys for a WebPubSub Service     examples:       - name: Regenerate the primary key for a WebPubSub Service.         text: >           az webpubsub key regenerate -n MyWebPubSub -g MyResourceGroup --key-type primary --query primaryKey -o tsv type: command     short-summary: Get the Network access control of WebPubSub Service. type: command     short-summary: Update the Network access control of WebPubSub Service.     examples:       - name: Set allowing RESTAPI only for public network.         text: >             az webpubsub network-rule update --public-network -n MyWebPubSub -g MyResourceGroup --allow RESTAPI       - name: Set allowing client connection and server connection for a private endpoint connection         text: >             az webpubsub network-rule update --connection-name MyPrivateEndpointConnection -n MyWebPubSub -g MyResourceGroup --allow ClientConnection ServerConnection       - name: Set denying client connection for both public network and private endpoint connections         text: >             az webpubsub network-rule update --public-network --connection-name MyPrivateEndpointConnection1 MyPrivateEndpointConnection2 -n MyWebPubSub -g MyResourceGroup --deny ClientConnection type: command     short-summary: Show hub settings for WebPubSub Service. type: command     short-summary: List all hub settings for WebPubSub Service. type: command     short-summary: Delete hub settings for WebPubSub Service. type: command     short-summary: Create hub settings for WebPubSub Service.     examples:       - name: Create a hub setting with two event handler settings         text: >             az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"       - name: Create a hub setting with anonymous connection allowed         text: >             az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true type: command     short-summary: Update hub settings for WebPubSub Service.     examples:       - name: Update event handler settings of a hub         text: >             az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"       - name: Update to allow anonymous connection         text: >             az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true type: command     short-summary: Start a interactive client connection. type: command     short-summary: Broadcast messages to hub.     examples:       - name: Send a message to hub         text: >             az webpubsub service broadcast -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --payload MyPayload type: command     short-summary: Check whether client connection exists type: command     short-summary: Close a specific client connection type: command     short-summary: Send a message to connection type: command     short-summary: Add a connection to group type: command     short-summary: Remove a connection from group type: command     short-summary: Add a user to group type: command     short-summary: Remove a user from group type: command     short-summary: Send a message to group type: command     short-summary: Send a message to user type: command     short-summary: Check if there are any client connections connected for the given user type: command     short-summary: Grant a group permission to the connection. type: command     short-summary: Revoke a group permission from the connection. type: command     short-summary: Check if a connection has permission to the specified group