az staticwebapp users

  • Reference

Manage users of the static app.

Commands

Name Description Type Status
az staticwebapp users invite

Create invitation link for specified user to the static app.

 Core GA
az staticwebapp users list

Lists users and assigned roles, limited to users who accepted their invites.

 Core GA
az staticwebapp users update

Updates a user entry with the listed roles. Either user details or user id is required.

 Core GA

az staticwebapp users invite

Create invitation link for specified user to the static app.

az staticwebapp users invite --authentication-provider
                             --domain
                             --invitation-expiration-in-hours
                             --name
                             --roles
                             --user-details
                             [--resource-group]

Examples

Create invitation link for specified user to the static app.

az staticwebapp users invite -n MyStaticAppName --authentication-provider GitHub --user-details JohnDoe --role Contributor --domain static-app-001.azurestaticapps.net --invitation-expiration-in-hours 1

Required Parameters

--authentication-provider

Authentication provider of the user identity such as AAD, Facebook, GitHub, Google, Twitter.

--domain

A domain added to the static app in quotes.

--invitation-expiration-in-hours

This value sets when the link will expire in hours. The maximum is 168 (7 days).

--name -n

Name of the static site.

--roles

Comma-separated default or user-defined role names. Roles that can be assigned to a user are comma separated and case-insensitive (at most 50 roles up to 25 characters each and restricted to 0-9,A-Z,a-z, and _). Define roles in routes.json during root directory of your GitHub repo.

--user-details

Email for AAD, Facebook, and Google. Account name (handle) for GitHub and Twitter.

Optional Parameters

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az staticwebapp users list

Lists users and assigned roles, limited to users who accepted their invites.

az staticwebapp users list --name
                           [--authentication-provider]
                           [--resource-group]

Examples

Lists users and assigned roles.

az staticwebapp users list -n MyStaticAppName

Required Parameters

--name -n

Name of the static site.

Optional Parameters

--authentication-provider

Authentication provider of the user identity such as AAD, Facebook, GitHub, Google, Twitter.

default value: all
--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az staticwebapp users update

Updates a user entry with the listed roles. Either user details or user id is required.

az staticwebapp users update --name
                             --roles
                             [--authentication-provider]
                             [--resource-group]
                             [--user-details]
                             [--user-id]

Examples

Updates a user entry with the listed roles.

az staticwebapp users update -n MyStaticAppName --user-details JohnDoe --role Contributor

Required Parameters

--name -n

Name of the static site.

--roles

Comma-separated default or user-defined role names. Roles that can be assigned to a user are comma separated and case-insensitive (at most 50 roles up to 25 characters each and restricted to 0-9,A-Z,a-z, and _). Define roles in routes.json during root directory of your GitHub repo.

Optional Parameters

--authentication-provider

Authentication provider of the user identity such as AAD, Facebook, GitHub, Google, Twitter.

--resource-group -g

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

--user-details

Email for AAD, Facebook, and Google. Account name (handle) for GitHub and Twitter.

--user-id

Given id of registered user.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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