az staticwebapp backends

  • リファレンス

静的 Web アプリを使用して、存在するバックエンドをリンクまたはリンク解除します。 "Bring Your Own API" とも呼ばれます。

コマンド

名前 説明 型 Status
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

バックエンドを静的 Web アプリにリンクします。 "Bring Your Own API" とも呼ばれます。

1 つの静的 Web アプリで使用できるバックエンドは 1 つだけです。 バックエンドが以前に別の静的 Web アプリにリンクされていた場合は、別の静的 Web アプリにリンクする前に、最初に認証構成をバックエンドから削除する必要があります。 静的 Web アプリ SKU は "Standard" である必要があります。 サポートされているバックエンドの種類は、Azure Functions、Azure API Management、Azure アプリ Service、Azure Container Apps です。 バックエンド リージョンは、Azure Functions および Azure アプリ Service 型のバックエンドに提供する必要があります。 詳細については、こちらを参照 https://video2.skills-academy.com/azure/static-web-apps/apis-overview してください。

az staticwebapp backends link --backend-resource-id
                              --name
                              --resource-group
                              [--backend-region]
                              [--environment-name]

バックエンドを静的 Web アプリにリンクする

az staticwebapp backends link -n MyStaticAppName -g MyResourceGroup --backend-resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/<resource-provider>/<resource-type>/<backend-name>" --backend-region MyBackendRegion

バックエンドを静的 Web アプリ環境にリンクする

az staticwebapp backends link -n MyStaticAppName -g MyResourceGroup --environment-name MyEnvironmentName --backend-resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/<resource-provider>/<resource-type>/<backend-name>" --backend-region MyBackendRegion
--backend-resource-id

リンクするバックエンドのリソース ID。

--name -n

静的サイトの名前。

--resource-group -g

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

--backend-region

バックエンド リソースのリージョン。

--environment-name

静的サイトの環境の名前。

既定値: default
グローバル パラメーター
--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 backends show

静的 Web アプリにリンクされているバックエンドの詳細を表示します。

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

例

静的 Web アプリバックエンドを表示します。

az staticwebapp backends show -n MyStaticAppName -g MyResourceGroup

環境の静的 Web アプリ バックエンドを表示します。

az staticwebapp backends show -n MyStaticAppName -g MyResourceGroup --environment-name MyEnvironmentName

必須のパラメーター

--name -n

静的サイトの名前。

--resource-group -g

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

省略可能のパラメーター

--environment-name

静的サイトの環境の名前。

既定値: default
グローバル パラメーター
--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 を使います。

静的 Web アプリからバックエンドのリンクを解除します。

az staticwebapp backends unlink --name
                                --resource-group
                                [--environment-name]
                                [--remove-backend-auth]

静的アプリ バックエンドのリンクを解除します。

az staticwebapp backends unlink -n MyStaticAppName -g MyResourceGroup

静的 Web アプリ環境からバックエンドのリンクを解除し、バックエンドから認証構成を削除します。

az staticwebapp backends unlink -n MyStaticAppName -g MyResourceGroup --environment-name MyEnvironmentName --remove-backend-auth
--name -n

静的サイトの名前。

--resource-group -g

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

--environment-name

静的サイトの環境の名前。

既定値: default
--remove-backend-auth

true に設定すると、リンク プロセス中にバックエンドで構成された ID プロバイダーが削除されます。

既定値: 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 backends validate

静的 Web アプリのバックエンドを検証します。

1 つの静的 Web アプリで使用できるバックエンドは 1 つだけです。 バックエンドが以前に別の静的 Web アプリにリンクされていた場合は、別の静的 Web アプリにリンクする前に、最初に認証構成をバックエンドから削除する必要があります。 静的 Web アプリ SKU は "Standard" である必要があります。 サポートされているバックエンドの種類は、Azure Functions、Azure API Management、Azure アプリ Service、Azure Container Apps です。 バックエンド リージョンは、Azure Functions および Azure アプリ Service 型のバックエンドに提供する必要があります。 詳細については、こちらを参照 https://video2.skills-academy.com/azure/static-web-apps/apis-overview してください。

az staticwebapp backends validate --backend-resource-id
                                  --name
                                  --resource-group
                                  [--backend-region]
                                  [--environment-name]

例

静的 Web アプリのバックエンドを検証する

az staticwebapp backends validate -n MyStaticAppName -g MyResourceGroup --backend-resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/<resource-provider>/<resource-type>/<backend-name>" --backend-region MyBackendRegion

静的 Web アプリ環境のバックエンドを検証する

az staticwebapp backends validate -n MyStaticAppName -g MyResourceGroup --environment-name MyEnvironmentName --backend-resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/<resource-provider>/<resource-type>/<backend-name>" --backend-region MyBackendRegion

必須のパラメーター

--backend-resource-id

リンクするバックエンドのリソース ID。

--name -n

静的サイトの名前。

--resource-group -g

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

省略可能のパラメーター

--backend-region

バックエンド リソースのリージョン。

--environment-name

静的サイトの環境の名前。

既定値: default
グローバル パラメーター
--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 を使います。