Received Shares - Register Tenant Email Registration

服務:

Purview

API 版本:

2023-02-15-preview

註冊要啟用的租用戶和電子郵件組合。
註冊目前租用戶的電子郵件

POST {endpoint}/emails:register?api-version=2023-02-15-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	purview 帳戶的共享端點。 範例：https://{accountName}.purview.azure.com/share
api-version	query	True	string	要使用的 API 版本

要求標頭

名稱	必要	類型	Description
repeatability-request-id		string	如果指定，用戶端會指示要求可重複;也就是說，用戶端可以使用相同的可重複性-Request-Id 多次提出要求，並取得適當的回應，而不需要伺服器多次執行要求。 Repeatability-Request-Id 的值是不透明的字元串，代表要求之客戶端產生的全域唯一標識符。 建議使用第 4 版（隨機）UUID。

回應

名稱	類型	Description
200 OK	TenantEmailRegistration	成功
Other Status Codes	PurviewShareError	默認錯誤回應。 標題 x-ms-error-code: string

安全性

azureAuth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://purview.azure.net/.default	Purview 服務範圍

範例

ReceivedShares_RegisterTenantEmailRegistration

範例要求

HTTP

POST accountName.purview.azure.com/share/emails:register?api-version=2023-02-15-preview

範例回覆

狀態碼:

200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
repeatability-request-id: b470712a-ffbc-4d9f-ab99-6640db8bbcb8

{
  "properties": {
    "activationCode": "15ee7153fe0df5a3a449a897d6cec836",
    "activationExpiration": "2022-08-16T22:35:17.2093506Z",
    "email": "john.smith@contoso.com",
    "registrationStatus": "ActivationPending",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "state": "Succeeded"
  },
  "id": "cb817140-a0cf-464f-8a82-0a9627a026ab",
  "type": "tenantEmailRegistration"
}

定義

名稱	Description
PurviewShareError	purview 共用錯誤模型。
PurviewShareErrorInfo	purview 共用錯誤主體模型。
State	資源的狀態
TenantEmailRegistration	租用戶電子郵件註冊數據傳輸物件。
TenantEmailRegistrationProperties	租用戶電子郵件註冊屬性包。
TenantEmailRegistrationStatus	定義註冊支持的類型。

PurviewShareError

Object

purview 共用錯誤模型。

名稱	類型	Description
error	PurviewShareErrorInfo	purview 共用錯誤主體模型。

PurviewShareErrorInfo

Object

purview 共用錯誤主體模型。

名稱	類型	Description
code	string	錯誤碼
details	PurviewShareErrorInfo[]	錯誤模型的巢狀詳細數據
message	string	錯誤的訊息
target	string	錯誤的目標

State

列舉型別

資源的狀態

值	Description
Unknown	資源的狀態為 「未知」
Succeeded	資源的狀態為 「成功」
Creating	資源的狀態為 「建立」
Deleting	資源的狀態為 「刪除」
Moving	資源的狀態為 「移動」
Failed	資源的狀態為 「失敗」

TenantEmailRegistration

Object

租用戶電子郵件註冊數據傳輸物件。

名稱	類型	Description
id	string	資源的唯一標識碼。
properties	TenantEmailRegistrationProperties	租用戶電子郵件註冊屬性包。
type	string	資源的類型。

TenantEmailRegistrationProperties

Object

租用戶電子郵件註冊屬性包。

名稱	類型	Description
activationCode	string	註冊的啟用碼。
activationExpiration	string (date-time)	啟用到期日的日期。 以標準日期時間格式表示，如 RFC 3339
email	string	要註冊的電子郵件。
registrationStatus	TenantEmailRegistrationStatus	定義註冊支持的類型。
state	State	資源的狀態
tenantId	string	要註冊的租用戶標識碼。

TenantEmailRegistrationStatus

列舉型別

定義註冊支持的類型。

值	Description
ActivationPending	租用戶電子郵件註冊處於擱置狀態
Activated	租用戶電子郵件註冊已完成且已啟動
ActivationAttemptsExhausted	租用戶電子郵件註冊已用盡最大嘗試