你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Static Sites - Register User Provided Function App With Static Site

使用静态站点注册用户提供的函数应用的说明

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}?api-version=2022-03-01
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}?isForced={isForced}&api-version=2022-03-01

URI 参数

Name In Required Type Description
functionAppName
path True
  • string

要注册到静态站点的函数应用的名称。

name
path True
  • string

静态站点的名称。

resourceGroupName
path True
  • string

资源所属的资源组的名称。

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True
  • string

Azure 订阅 ID。 这是 GUID 格式的字符串, (例如 000000000-0000-0000-0000-00000000000000) 。

api-version
query True
  • string

API 版本

isForced
query
  • boolean

指定 true 以强制更新函数应用上的身份验证配置,即使已在函数应用中配置 AzureStaticWebApps 提供程序也是如此。 默认为 false

请求正文

Name Type Description
kind
  • string

资源类型。

properties.functionAppRegion
  • string

向静态站点注册的函数应用的区域

properties.functionAppResourceId
  • string

向静态站点注册的函数应用的资源 ID

响应

Name Type Description
200 OK

没问题。

202 Accepted

正在进行异步操作。

Other Status Codes

App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Register a user provided function app with a static site

Sample Request

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/userProvidedFunctionApps/testFunctionApp?isForced=true&api-version=2022-03-01

{
  "properties": {
    "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp",
    "functionAppRegion": "West US 2"
  }
}

Sample Response

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp",
  "name": "testFunctionApp",
  "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps",
  "properties": {
    "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp",
    "functionAppRegion": "West US 2",
    "createdOn": "2020-03-04T17:33:11.641Z"
  }
}
azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01
{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/builds/default/userProvidedFunctionApps/testFunctionApp",
  "name": "testFunctionApp",
  "type": "Microsoft.Web/staticSites/builds/userProvidedFunctionApps",
  "properties": {
    "functionAppResourceId": "/subscription/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/functionRG/providers/Microsoft.Web/sites/testFunctionApp",
    "functionAppRegion": "West US 2",
    "createdOn": "2020-03-04T17:33:11.641Z"
  }
}

定义

DefaultErrorResponse

App 服务错误响应。

Details
Error

错误模型。

StaticSiteUserProvidedFunctionAppARMResource

静态站点用户提供的 Function App ARM 资源。

DefaultErrorResponse

App 服务错误响应。

Name Type Description
error

错误模型。

Details

Name Type Description
code
  • string

标准化字符串以编程方式标识错误。

message
  • string

详细的错误说明和调试信息。

target
  • string

详细的错误说明和调试信息。

Error

错误模型。

Name Type Description
code
  • string

标准化字符串以编程方式标识错误。

details

详细错误。

innererror
  • string

有关调试错误的详细信息。

message
  • string

详细的错误说明和调试信息。

target
  • string

详细的错误说明和调试信息。

StaticSiteUserProvidedFunctionAppARMResource

静态站点用户提供的 Function App ARM 资源。

Name Type Description
id
  • string

资源 ID。

kind
  • string

资源类型。

name
  • string

资源名称。

properties.createdOn
  • string

函数应用注册到静态站点的日期和时间。

properties.functionAppRegion
  • string

向静态站点注册的函数应用的区域

properties.functionAppResourceId
  • string

向静态站点注册的函数应用的资源 ID

type
  • string

资源类型。