EmailRegistrationClient.Activate Méthode

Référence

Définition

Espace de noms:: Azure.Analytics.Purview.Share

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

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

Source:: EmailRegistrationClient.cs

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Active la combinaison de locataire et d’e-mail à l’aide du code d’activation reçu.

public virtual Azure.Response Activate (Azure.Core.RequestContent content, string repeatabilityRequestId = default, Azure.RequestContext context = default);

abstract member Activate : Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response
override this.Activate : Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Response

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

Paramètres

content: RequestContent

Contenu à envoyer en tant que corps de la demande. Les détails du schéma du corps de la demande se trouvent dans la section Remarques ci-dessous.

repeatabilityRequestId: String

Si elle est spécifiée, le client indique que la demande est reproductible ; autrement dit, le client peut effectuer la requête plusieurs fois avec le même Repeatability-Request-ID et obtenir une réponse appropriée sans que le serveur n’exécute la demande plusieurs fois. La valeur de Repeatability-Request-Id est une chaîne opaque représentant un identificateur généré par le client, globalement unique pour tout le temps, pour la requête. Il est recommandé d’utiliser des UUID version 4 (aléatoires).

context: RequestContext

Contexte de la demande, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

Response

Réponse retournée par le service. Les détails du schéma du corps de la réponse se trouvent dans la section Remarques ci-dessous.

Exceptions

ArgumentNullException

content a la valeur null.

RequestFailedException

Le service a retourné un code de status non réussi.

Exemples

Cet exemple montre comment appeler Activate avec les paramètres requis et analyser le résultat.

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

var data = new {};

Response response = client.Activate(RequestContent.Create(data));

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

Cet exemple montre comment appeler Activate avec tous les paramètres et demander du contenu, et comment analyser le résultat.

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

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

Response response = client.Activate(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());

Remarques

Active l’inscription par e-mail pour le locataire actuel

Vous trouverez ci-dessous le schéma JSON pour les charges utiles de requête et de réponse.

Corps de la demande :

Schéma pour 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.
            }

Corps de réponse :