az staticwebapp

リファレンス

Note

このコマンドグループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。各拡張機能をインストールして、拡張機能を活用します。拡張機能の詳細をご覧ください。

静的アプリを管理します。

コマンド

名前	説明	型	Status
az staticwebapp appsettings	静的アプリのアプリ設定を管理します。	コア	GA
az staticwebapp appsettings delete	静的アプリの特定のキーを使用してアプリ設定を削除します。	コア	GA
az staticwebapp appsettings list	静的アプリのアプリ設定を一覧表示します。	コア	GA
az staticwebapp appsettings set	静的アプリのアプリ設定を追加または変更します。	コア	GA
az staticwebapp backends	静的 Web アプリを使用して、存在するバックエンドをリンクまたはリンク解除します。 "Bring Your Own API" とも呼ばれます。	コア	GA
az staticwebapp backends link	バックエンドを静的 Web アプリにリンクします。 "Bring Your Own API" とも呼ばれます。	コア	GA
az staticwebapp backends show	静的 Web アプリにリンクされているバックエンドの詳細を表示します。	コア	GA
az staticwebapp backends unlink	静的 Web アプリからバックエンドのリンクを解除します。	コア	GA
az staticwebapp backends validate	静的 Web アプリのバックエンドを検証します。	コア	GA
az staticwebapp create	静的アプリを作成します。静的 Web アプリにコンテンツを提供し、Github リポジトリと統合するには、Github リポジトリの URL (--source) とブランチ (--branch) を指定します。リポジトリが Github 組織の下にある場合は、Azure CLI Github アプリが組織にアクセスできることを確認してください。 "--login-with-github" 引数を使用する場合は、ブラウザーでアクセスを要求できます。組織の管理者がアクセス権を付与する必要があります。	コア	GA
az staticwebapp dbconnection	静的 Web アプリのデータベース接続を管理します。	拡張	プレビュー
az staticwebapp dbconnection create	静的 Web アプリデータベース接続を作成します。	拡張	プレビュー
az staticwebapp dbconnection delete	静的 Web アプリデータベース接続を削除します。	拡張	プレビュー
az staticwebapp dbconnection show	静的 Web アプリデータベース接続の詳細を取得します。	拡張	プレビュー
az staticwebapp delete	静的アプリを削除します。	コア	GA
az staticwebapp disconnect	ソース管理を切断して、別のリポジトリへの接続を有効にします。	コア	GA
az staticwebapp enterprise-edge	静的 Web アプリ用の Azure Front Door CDN を管理します。最適なエクスペリエンスと可用性を得るためのドキュメントhttps://aka.ms/swaedgeチェックしてください。	コア	GA
az staticwebapp enterprise-edge disable	静的 Web アプリの Azure Front Door CDN を無効にします。最適なエクスペリエンスと可用性を得るためのドキュメントhttps://aka.ms/swaedgeチェックしてください。	コア	GA
az staticwebapp enterprise-edge enable	静的 Web アプリに対して Azure Front Door CDN を有効にします。エンタープライズレベルのエッジを有効にするには、Azure Front Door Microsoft.CDN リソースプロバイダーの再登録が必要です。最適なエクスペリエンスと可用性を得るためのドキュメントhttps://aka.ms/swaedgeチェックしてください。	コア	GA
az staticwebapp enterprise-edge show	Web アプリの Azure Front Door CDN の状態 (有効、無効、有効化、無効化) を表示します。最適なエクスペリエンスと可用性を得るためのドキュメントhttps://aka.ms/swaedgeチェックしてください。	コア	GA
az staticwebapp environment	静的アプリの環境を管理します。	コア	GA
az staticwebapp environment delete	静的アプリの運用環境または指定した環境を削除します。	コア	GA
az staticwebapp environment functions	関数に関する情報を表示します。	コア	GA
az staticwebapp environment list	運用環境を含む静的アプリのすべての環境を一覧表示します。	コア	GA
az staticwebapp environment show	運用環境または指定した環境に関する情報を表示します。	コア	GA
az staticwebapp functions	事前に定義されている関数アプリを静的 Web アプリにリンクまたはリンク解除します。 "Bring Your Own Functions" とも呼ばれます。	コア	GA
az staticwebapp functions link	Azure 関数を静的 Web アプリにリンクします。 "Bring Your Own Functions" とも呼ばれます。1 つの静的 Web アプリで使用できる Azure Functions アプリは 1 つだけです。静的 Web アプリ SKU は "Standard" である必要があります。	コア	GA
az staticwebapp functions show	静的 Web アプリにリンクされている Azure 関数の詳細を表示します。	コア	GA
az staticwebapp functions unlink	静的 Web アプリから Azure 関数のリンクを解除します。	コア	GA
az staticwebapp hostname	静的アプリの Functions のカスタムホスト名を管理します。	コア	GA
az staticwebapp hostname delete	静的アプリの指定されたホスト名を削除します。	コア	GA
az staticwebapp hostname list	静的アプリのカスタムホスト名を一覧表示します。	コア	GA
az staticwebapp hostname set	指定されたサブ doメインホスト名を静的アプリに設定します。 DNS プロバイダーで CNAME/TXT/ALIAS レコードを構成してください。検証を待機しない場合は、--no-wait を使用します。	コア	GA
az staticwebapp hostname show	staticwebapp カスタム doメインの詳細を取得します。 TXT doメイン検証の検証トークンをフェッチするために使用できます (例を参照)。	コア	GA
az staticwebapp identity	静的 Web アプリのマネージド ID を管理します。	コア	GA
az staticwebapp identity assign	静的 Web アプリにマネージド ID を割り当てます。	コア	GA
az staticwebapp identity remove	静的 Web アプリのマネージド ID を無効にします。	コア	GA
az staticwebapp identity show	静的 Web アプリのマネージド ID を表示します。	コア	GA
az staticwebapp list	サブスクリプション内またはリソースグループ内のすべての静的アプリリソース (指定されている場合) を一覧表示します。	コア	GA
az staticwebapp reconnect	disconnect コマンドに従って、リポジトリとブランチに接続します。	コア	GA
az staticwebapp secrets	静的アプリのデプロイトークンを管理します。	コア	GA
az staticwebapp secrets list	静的アプリのデプロイトークンを一覧表示します。	コア	GA
az staticwebapp secrets reset-api-key	静的アプリのデプロイトークンをリセットします。	コア	GA
az staticwebapp show	静的アプリの詳細を表示します。	コア	GA
az staticwebapp update	静的アプリを更新します。更新されたアプリを返します。	コア	GA
az staticwebapp users	静的アプリのユーザーを管理します。	コア	GA
az staticwebapp users invite	指定したユーザーの静的アプリへの招待リンクを作成します。	コア	GA
az staticwebapp users list	招待を受け入れたユーザーに限定された、ユーザーと割り当てられたロールを一覧表示します。	コア	GA
az staticwebapp users update	一覧に示されているロールを持つユーザーエントリを更新します。ユーザーの詳細またはユーザー ID が必要です。	コア	GA

az staticwebapp create

静的アプリを作成します。静的 Web アプリにコンテンツを提供し、Github リポジトリと統合するには、Github リポジトリの URL (--source) とブランチ (--branch) を指定します。リポジトリが Github 組織の下にある場合は、Azure CLI Github アプリが組織にアクセスできることを確認してください。 "--login-with-github" 引数を使用する場合は、ブラウザーでアクセスを要求できます。組織の管理者がアクセス権を付与する必要があります。

az staticwebapp create --name
                       --resource-group
                       [--api-location]
                       [--app-location]
                       [--branch]
                       [--location]
                       [--login-with-ado]
                       [--login-with-github]
                       [--no-wait]
                       [--output-location]
                       [--sku {Free, Standard}]
                       [--source]
                       [--tags]
                       [--token]

例

サブスクリプションに静的アプリを作成します。

az staticwebapp create -n MyStaticAppName -g MyExistingRg -s https://github.com/JohnDoe/my-first-static-web-app -l WestUs2 -b master -t MyAccessToken

サブスクリプションに静的アプリを作成し、対話形式でトークンを取得する

az staticwebapp create -n MyStaticAppName -g MyExistingRg -s https://github.com/JohnDoe/my-first-static-web-app -l WestUs2 -b master --login-with-github

コンテンツなしで GitHub 統合なしで静的 Web アプリを作成する

az staticwebapp create -n MyStaticAppName -g MyExistingRg

必須のパラメーター

--name -n

静的サイトの名前。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--api-location

Azure Functions コードの場所です。たとえば、'/api' は 'api' という名前のフォルダーを表します。

--app-location

アプリケーションコードの場所です。たとえば、'/' はアプリのルートを表し、'/app' は 'app' という名前のディレクトリを表します。

既定値: /

--branch -b

リポジトリ内のターゲットブランチ。

--location -l

場所。値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

既定値: centralus

--login-with-ado

Azure 資格情報を使用して、Azure Dev Ops の個人用アクセストークンを作成します。

既定値: False

--login-with-github

Github を使用して対話形式でログインし、個人用アクセストークンを取得します。

既定値: False

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--output-location

アプリの場所を基準としたビルド出力のパス。たとえば、アプリの場所が '/app' に設定されている場合に値 'build' を設定すると、'/app/build' のコンテンツが提供されます。

--sku

静的 Web アプリの価格レベル。

承認された値: Free, Standard

既定値: Free

--source -s

静的サイトのリポジトリの URL。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--token -t

ユーザーの GitHub または Azure Dev Ops リポジトリトークン。これは、Github アクションまたは Dev Ops パイプラインを作成するために使用されます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az staticwebapp delete

静的アプリを削除します。

az staticwebapp delete --name
                       [--no-wait]
                       [--resource-group]
                       [--yes]

例

静的アプリを削除します。

az staticwebapp delete -n MyStaticAppName -g MyRg

必須のパラメーター

--name -n

静的サイトの名前。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az staticwebapp disconnect

ソース管理を切断して、別のリポジトリへの接続を有効にします。

az staticwebapp disconnect --name
                           [--no-wait]
                           [--resource-group]

例

静的アプリを切断します。

az staticwebapp disconnect -n MyStaticAppName

必須のパラメーター

--name -n

静的サイトの名前。

省略可能のパラメーター

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az staticwebapp list

サブスクリプション内またはリソースグループ内のすべての静的アプリリソース (指定されている場合) を一覧表示します。

az staticwebapp list [--resource-group]

例

サブスクリプション内の静的アプリを一覧表示します。

az staticwebapp list

省略可能のパラメーター

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az staticwebapp reconnect

disconnect コマンドに従って、リポジトリとブランチに接続します。

az staticwebapp reconnect --branch
                          --name
                          --source
                          [--login-with-github]
                          [--no-wait]
                          [--resource-group]
                          [--token]

例

リポジトリとブランチを静的アプリに接続します。

az staticwebapp reconnect -n MyStaticAppName --source MyGitHubRepo -b master --token MyAccessToken

リポジトリとブランチを静的アプリに接続し、対話形式でトークンを取得する

az staticwebapp reconnect -n MyStaticAppName --source MyGitHubRepo -b master --login-with-github

必須のパラメーター

--branch -b

リポジトリ内のターゲットブランチ。

--name -n

静的サイトの名前。

--source -s

静的サイトのリポジトリの URL。

省略可能のパラメーター

--login-with-github

Github を使用して対話形式でログインし、個人用アクセストークンを取得します。

既定値: False

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--token -t

ユーザーの GitHub または Azure Dev Ops リポジトリトークン。これは、Github アクションまたは Dev Ops パイプラインを作成するために使用されます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az staticwebapp show

静的アプリの詳細を表示します。

az staticwebapp show --name
                     [--resource-group]

例

サブスクリプションに静的アプリを表示します。

az staticwebapp show -n MyStaticAppName

必須のパラメーター

--name -n

静的サイトの名前。

省略可能のパラメーター

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az staticwebapp update

静的アプリを更新します。更新されたアプリを返します。

az staticwebapp update --name
                       [--branch]
                       [--no-wait]
                       [--resource-group]
                       [--sku {Free, Standard}]
                       [--source]
                       [--tags]
                       [--token]

例

静的アプリを Standard SKU に更新します。

az staticwebapp update -n MyStaticAppName --sku Standard

必須のパラメーター

--name -n

静的サイトの名前。

省略可能のパラメーター

--branch -b

リポジトリ内のターゲットブランチ。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--sku

静的 Web アプリの価格レベル。

承認された値: Free, Standard

--source -s

静的サイトのリポジトリの URL。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--token -t

ユーザーの GitHub または Azure Dev Ops リポジトリトークン。これは、Github アクションまたは Dev Ops パイプラインを作成するために使用されます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az staticwebapp

コマンド

az staticwebapp create

例

必須のパラメーター

省略可能のパラメーター

az staticwebapp delete

例

必須のパラメーター

省略可能のパラメーター

az staticwebapp disconnect

例

必須のパラメーター

省略可能のパラメーター

az staticwebapp list

例

省略可能のパラメーター

az staticwebapp reconnect

例

必須のパラメーター

省略可能のパラメーター

az staticwebapp show

例

必須のパラメーター

省略可能のパラメーター

az staticwebapp update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース