Share via

az webpubsub service permission

Note

This reference is part of the webpubsub extension for the Azure CLI (version 2.56.0 or higher). The extension will automatically install the first time you run an az webpubsub service permission command. Learn more about extensions.

Commands to manage Webpubsub service permissions.

Commands

Name Description Type Status
az webpubsub service permission check

Check if a connection has permission to the specified group.

 Extension GA
az webpubsub service permission grant

Grant a group permission to the connection. Error throws if operation fails.

 Extension GA
az webpubsub service permission revoke

Revoke a group permission from the connection. Error throws if operation fails.

 Extension GA

az webpubsub service permission check

Check if a connection has permission to the specified group.

az webpubsub service permission check --connection-id
                                      --group-name
                                      --hub-name
                                      --permission {joinLeaveGroup, sendToGroup}
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Required Parameters

--connection-id

The connection id.

--group-name

The group name.

--hub-name

The hub to manage.

--permission

The permission.

Property Value
Accepted values: joinLeaveGroup, sendToGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the webpubsub.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub service permission grant

Grant a group permission to the connection. Error throws if operation fails.

az webpubsub service permission grant --connection-id
                                      --group-name
                                      --hub-name
                                      --permission {joinLeaveGroup, sendToGroup}
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Required Parameters

--connection-id

The connection id.

--group-name

The group name.

--hub-name

The hub to manage.

--permission

The permission.

Property Value
Accepted values: joinLeaveGroup, sendToGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the webpubsub.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az webpubsub service permission revoke

Revoke a group permission from the connection. Error throws if operation fails.

az webpubsub service permission revoke --connection-id
                                       --group-name
                                       --hub-name
                                       --permission {joinLeaveGroup, sendToGroup}
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Required Parameters

--connection-id

The connection id.

--group-name

The group name.

--hub-name

The hub to manage.

--permission

The permission.

Property Value
Accepted values: joinLeaveGroup, sendToGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the webpubsub.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False