Received Shares - Register Tenant Email Registration

Szolgáltatás:

Purview

API-verzió:

2023-02-15-preview

Regisztrálja a bérlő és az e-mail kombinációt az aktiváláshoz.
E-mail regisztrálása az aktuális bérlőhöz

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A purview-fiók megosztási végpontja. Példa: https://{accountName}.purview.azure.com/share
api-version	query	True	string	A használni kívánt API-verzió

Kérelem fejléce

Name	Kötelező	Típus	Description
repeatability-request-id		string	Ha meg van adva, az ügyfél azt irányítja, hogy a kérés megismételhető legyen; vagyis az ügyfél többször is végrehajthatja a kérést ugyanazzal az ismétlhetőséggel–Request-Id és a megfelelő választ kaphatja vissza anélkül, hogy a kiszolgáló többször hajtja végre a kérést. Az ismétlhetőségiRequest-Id értéke egy átlátszatlan sztring, amely egy ügyfél által generált, globálisan minden alkalommal egyedi, a kérés azonosítóját jelöli. A 4-es (véletlenszerű) UUID-k használata ajánlott.

Válaszok

Name	Típus	Description
200 OK	TenantEmailRegistration	Siker
Other Status Codes	PurviewShareError	Alapértelmezett hibaválasz. Fejlécek x-ms-error-code: string

Biztonság

azureAuth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
https://purview.azure.net/.default	Purview szolgáltatás hatóköre

Példák

ReceivedShares_RegisterTenantEmailRegistration

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

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"
}

Definíciók

Name	Description
PurviewShareError	A purview megosztási hibamodellje.
PurviewShareErrorInfo	A purview megosztási hibatörzsmodellje.
State	Az erőforrás állapota
TenantEmailRegistration	Bérlői e-mail-regisztrációs adatátviteli objektum.
TenantEmailRegistrationProperties	Bérlői e-mail-regisztrációs tulajdonságcsomag.
TenantEmailRegistrationStatus	Meghatározza a regisztráció támogatott típusait.

PurviewShareError

Objektum

A purview megosztási hibamodellje.

Name	Típus	Description
error	PurviewShareErrorInfo	A purview megosztási hibatörzsmodellje.

PurviewShareErrorInfo

Objektum

A purview megosztási hibatörzsmodellje.

Name	Típus	Description
code	string	A hiba kódja
details	PurviewShareErrorInfo[]	A hibamodell beágyazott részletei
message	string	A hiba üzenete
target	string	A hiba célja

State

Enumerálás

Az erőforrás állapota

Érték	Description
Creating	Az erőforrás állapota "Létrehozás"
Deleting	Az erőforrás állapota "Törlés"
Failed	Az erőforrás állapota "Sikertelen"
Moving	Az erőforrás állapota "Áthelyezés"
Succeeded	Az erőforrás állapota "Sikeres"
Unknown	Az erőforrás állapota "Ismeretlen"

TenantEmailRegistration

Objektum

Bérlői e-mail-regisztrációs adatátviteli objektum.

Name	Típus	Description
id	string	Az erőforrás egyedi azonosítója.
properties	TenantEmailRegistrationProperties	Bérlői e-mail-regisztrációs tulajdonságcsomag.
type	string	Az erőforrás típusa.

TenantEmailRegistrationProperties

Objektum

Bérlői e-mail-regisztrációs tulajdonságcsomag.

Name	Típus	Description
activationCode	string	Aktiválási kód a regisztrációhoz.
activationExpiration	string (date-time)	Az aktiválás lejáratának dátuma. A RFC 3339 által meghatározott szabványos dátum-idő formátumban jelenik meg
email	string	A regisztrálandó e-mail.
registrationStatus	TenantEmailRegistrationStatus	Meghatározza a regisztráció támogatott típusait.
state	State	Az erőforrás állapota
tenantId	string	A regisztrálandó bérlőazonosító.

TenantEmailRegistrationStatus

Enumerálás

Meghatározza a regisztráció támogatott típusait.

Érték	Description
Activated	A bérlői e-mail regisztráció befejeződött, és aktiválva lett
ActivationAttemptsExhausted	A bérlői e-mail-regisztráció kimerítette a maximális kísérleteket
ActivationPending	A bérlői e-mail-regisztráció függőben van