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

Static Sites - Create User Roles Invitation Link

有关为具有角色的用户创建邀请链接的说明

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/createUserInvitation?api-version=2022-03-01

URI 参数

Name In Required Type Description
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 版本

请求正文

Name Type Description
kind
  • string

资源类型。

properties.domain
  • string

静态网站自定义域的域名。

properties.numHoursToExpiration
  • integer

sas 令牌保持有效状态的小时数

properties.provider
  • string

静态站点用户的标识提供者。

properties.roles
  • string

静态站点用户的角色,采用自由格式的字符串格式

properties.userDetails
  • string

静态站点用户的用户 ID。

响应

Name Type Description
200 OK

没问题。

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 模拟用户帐户

示例

Sample Request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Web/staticSites/testStaticSite0/createUserInvitation?api-version=2022-03-01

{
  "properties": {
    "domain": "happy-sea-15afae3e.azurestaticwebsites.net",
    "provider": "aad",
    "userDetails": "username",
    "roles": "admin,contributor",
    "numHoursToExpiration": 1
  }
}

Sample Response

{
  "properties": {
    "invitationUrl": "https://happy-sea-15afae3e.azurestaticwebsites.net?invite=asdf",
    "expiresOn": "2020-02-28T16:53:56.211Z"
  }
}

定义

DefaultErrorResponse

App 服务错误响应。

Details
Error

错误模型。

StaticSiteUserInvitationRequestResource

静态站点用户角色邀请资源。

StaticSiteUserInvitationResponseResource

静态站点用户角色邀请链接资源。

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

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

StaticSiteUserInvitationRequestResource

静态站点用户角色邀请资源。

Name Type Description
id
  • string

资源 ID。

kind
  • string

资源类型。

name
  • string

资源名称。

properties.domain
  • string

静态网站自定义域的域名。

properties.numHoursToExpiration
  • integer

sas 令牌保持有效状态的小时数

properties.provider
  • string

静态站点用户的标识提供者。

properties.roles
  • string

静态站点用户的角色,采用自由格式的字符串格式

properties.userDetails
  • string

静态站点用户的用户 ID。

type
  • string

资源类型。

StaticSiteUserInvitationResponseResource

静态站点用户角色邀请链接资源。

Name Type Description
id
  • string

资源 ID。

kind
  • string

资源类型。

name
  • string

资源名称。

properties.expiresOn
  • string

邀请的到期时间

properties.invitationUrl
  • string

邀请链接的 URL

type
  • string

资源类型。