ReceivedSharesClient.RegisterTenantEmailRegistration Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[Protocol Method] Registers the tenant and email combination for activation.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Response RegisterTenantEmailRegistration (string repeatabilityRequestId = default, Azure.RequestContext context = default);
abstract member RegisterTenantEmailRegistration : string * Azure.RequestContext -> Azure.Response
override this.RegisterTenantEmailRegistration : string * Azure.RequestContext -> Azure.Response
Public Overridable Function RegisterTenantEmailRegistration (Optional repeatabilityRequestId As String = Nothing, Optional context As RequestContext = Nothing) As Response
Parameters
- repeatabilityRequestId
- String
If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
Service returned a non-success status code.
Examples
This sample shows how to call RegisterTenantEmailRegistration and parse the result.
var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ReceivedSharesClient(endpoint, credential);
Response response = client.RegisterTenantEmailRegistration();
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
This sample shows how to call RegisterTenantEmailRegistration with all parameters, and how to parse the result.
var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ReceivedSharesClient(endpoint, credential);
Response response = client.RegisterTenantEmailRegistration("<repeatabilityRequestId>");
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("properties").GetProperty("activationCode").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("activationExpiration").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("email").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("registrationStatus").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("state").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("tenantId").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("type").ToString());
Remarks
Register an email for the current tenant
Below is the JSON schema for the response payload.
Response Body:
Schema for TenantEmailRegistration
:
{
properties: {
activationCode: string, # Required. Activation code for the registration.
activationExpiration: string (ISO 8601 Format), # Optional. Date of the activation expiration. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
email: string, # Optional. The email to register.
registrationStatus: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted", # Optional. Defines the supported types for registration.
state: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed", # Optional. State of the resource
tenantId: string, # Optional. The tenant id to register.
}, # Optional. Tenant email registration property bag.
id: string, # Optional. The unique id of the resource.
type: string, # Optional. Type of the resource.
}
Applies to
Azure SDK for .NET