Email Registrations - Register Email

Reference

Service:: Data Share

API Version:: 2021-08-01

Registers the tenant and email combination for verification.
Register an email for the current tenant

POST https://management.azure.com/providers/Microsoft.DataShare/locations/{location}/registerEmail?api-version=2021-08-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	Location of the registration
api-version	query	True	string	The api version to use.

Responses

Name	Type	Description
200 OK	EmailRegistration	Success
Other Status Codes	DataShareError	An error response received from the Microsoft.DataShare resource provider.

Security

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	impersonate your user account

Examples

EmailRegistrations_RegisterEmail

POST https://management.azure.com/providers/Microsoft.DataShare/locations/East US 2/registerEmail?api-version=2021-08-01

using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataShare;
using Azure.ResourceManager.DataShare.Models;

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/EmailRegistrations_RegisterEmail.json
// this example is just showing the usage of "EmailRegistrations_RegisterEmail" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation
AzureLocation location = new AzureLocation("East US 2");
DataShareEmailRegistration result = await tenantResource.RegisterEmailAsync(location);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

Date: Wed, 13 Sep 2021 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

Response Body

{
  "tenantId": "9f532315-b048-4374-8de1-14734d9b7f77",
  "email": "receiver@microsoft.com",
  "registrationStatus": "ActivationPending",
  "activationCode": null,
  "activationExpirationDate": "2022-08-12T16:44:53.688049Z"
}

Definitions

Name	Description
DataShareError	The data share error model.
DataShareErrorInfo	The data share error body model.
EmailRegistration	Dto for tenant domain registration
registrationStatus	Registration status

DataShareError

The data share error model.

Name	Type	Description
error	DataShareErrorInfo	The data share error body

DataShareErrorInfo

The data share error body model.

Name	Type	Description
code	string	Code of the error
details	DataShareErrorInfo[]	Nested details of the error model
message	string	Message of the error
target	string	Target of the error

EmailRegistration

Dto for tenant domain registration

Name	Type	Description
activationCode	string	Activation code for the registration
activationExpirationDate	string	Date of the activation expiration
email	string	The email to register
registrationStatus	registrationStatus	Registration status
tenantId	string	The tenant to register

registrationStatus

Registration status

Name	Type	Description
Activated	string
ActivationAttemptsExhausted	string
ActivationPending	string