EmailRegistrationClient.ActivateAsync Método

Referência

Definição

Namespace:: Azure.Analytics.Purview.Share

Assembly:: Azure.Analytics.Purview.Share.dll

Pacote:: Azure.Analytics.Purview.Share v1.0.3-beta.20

Origem:: EmailRegistrationClient.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Ativa a combinação de locatário e email usando o código de ativação recebido.

public virtual System.Threading.Tasks.Task<Azure.Response> ActivateAsync (Azure.Core.RequestContent content, string repeatabilityRequestId = default, Azure.RequestContext context = default);

abstract member ActivateAsync : Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.ActivateAsync : Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function ActivateAsync (content As RequestContent, Optional repeatabilityRequestId As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parâmetros

content: RequestContent

O conteúdo a ser enviado como o corpo da solicitação. Os detalhes do esquema do corpo da solicitação estão na seção Comentários abaixo.

repeatabilityRequestId: String

Se especificado, o cliente direciona que a solicitação é repetível; ou seja, o cliente pode fazer a solicitação várias vezes com a mesma Repeatability-Request-Id e obter de volta uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor do Repeatability-Request-Id é uma cadeia de caracteres opaca que representa um identificador gerado pelo cliente, globalmente exclusivo para todos os tempos, para a solicitação. É recomendável usar UUIDs da versão 4 (aleatória).

context: RequestContext

O contexto de solicitação, que pode substituir os comportamentos padrão do pipeline do cliente por chamada.

Retornos

Task<Response>

A resposta retornada do serviço. Os detalhes do esquema do corpo da resposta estão na seção Comentários abaixo.

Exceções

ArgumentNullException

content é nulo.

RequestFailedException

O serviço retornou um código de status sem êxito.

Exemplos

Este exemplo mostra como chamar ActivateAsync com os parâmetros necessários e analisar o resultado.

var credential = new DefaultAzureCredential();
var client = new EmailRegistrationClient("<https://my-service.azure.com>", credential);

var data = new {};

Response response = await client.ActivateAsync(RequestContent.Create(data));

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

Este exemplo mostra como chamar ActivateAsync com todos os parâmetros e conteúdo da solicitação e como analisar o resultado.

var credential = new DefaultAzureCredential();
var client = new EmailRegistrationClient("<https://my-service.azure.com>", credential);

var data = new {
    properties = new {
        activationCode = "<TenantEmailRegistrationPropertiesActivationCode>",
    },
};

Response response = await client.ActivateAsync(RequestContent.Create(data), "<repeatabilityRequestId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("type").ToString());
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("tenantId").ToString());

Comentários

Ativa o registro de email para o locatário atual

Abaixo está o esquema JSON para as cargas de solicitação e resposta.

Corpo da solicitação:

Esquema para TenantEmailRegistration:

{
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              properties: {
                activationCode: string, # Required. Activation code for the registration.
                activationExpiration: string (ISO 8601 Format), # Optional. Date of the activation expiration.
                email: string, # Optional. The email to register.
                registrationStatus: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted", # Optional. Defines the supported types for registration.
                tenantId: string, # Optional. The tenant id to register.
              }, # Optional. Tenant email registration property bag.
            }

Corpo da resposta: