SentSharesClient.NotifyUserSentShareInvitationAsync Método

Referência

Definição

Namespace:: Azure.Analytics.Purview.Sharing

Assembly:: Azure.Analytics.Purview.Sharing.dll

Pacote:: Azure.Analytics.Purview.Sharing v1.0.0-beta.3

Origem:: SentSharesClient.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.

[Método protocol] Notifica o destinatário do convite de compartilhamento enviado.

Esse método de protocolo permite a criação explícita da solicitação e o processamento da resposta para cenários avançados.

public virtual System.Threading.Tasks.Task<Azure.Response> NotifyUserSentShareInvitationAsync (string sentShareId, string sentShareInvitationId, string repeatabilityRequestId = default, Azure.RequestContext context = default);

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

Public Overridable Function NotifyUserSentShareInvitationAsync (sentShareId As String, sentShareInvitationId As String, Optional repeatabilityRequestId As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parâmetros

sentShareId: String

Id do compartilhamento enviado.

sentShareInvitationId: String

Id do convite de compartilhamento enviado.

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.

Exceções

ArgumentNullException

sentShareId ou sentShareInvitationId é nulo.

ArgumentException

sentShareId ou sentShareInvitationId é uma cadeia de caracteres vazia e esperava-se que não estivesse vazia.

RequestFailedException

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

Exemplos

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

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

Response response = await client.NotifyUserSentShareInvitationAsync("<sentShareId>", "<sentShareInvitationId>");

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

Este exemplo mostra como chamar NotifyUserSentShareInvitationAsync com todos os parâmetros e como analisar o resultado.

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

Response response = await client.NotifyUserSentShareInvitationAsync("<sentShareId>", "<sentShareInvitationId>", "<repeatabilityRequestId>");

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("invitationKind").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("type").ToString());

Comentários

Notifica o usuário destinatário do convite de compartilhamento enviado, não se aplica a convites de serviço.

Abaixo está o esquema JSON para o conteúdo da resposta.

Corpo da resposta:

Esse método usa um dos objetos JSON abaixo como uma carga. Selecione um objeto JSON para exibir o esquema para isso.

ServiceInvitation

Esquema para ServiceInvitation:

{
  properties: {
    expirationDate: string (ISO 8601 Format), # Optional. The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    senderEmail: string, # Optional. Email address of the sender.
    senderName: string, # Optional. Name of the sender
    senderTenantName: string, # Optional. Tenant name of the sender
    sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    shareStatus: "Detached" | "Attached", # Optional. Share status.
    state: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed", # Optional. State of the resource
    targetActiveDirectoryId: Guid, # Required. The target azure active directory id the invitation is sent to.
    targetObjectId: Guid, # Required. The target object id in the azure active directory the invitation is sent to.
  }, # Required. Properties of the service invitation type.
  invitationKind: Service, # Required. The types of invitations.
  id: string, # Optional. The unique id of the resource.
  type: string, # Optional. Type of the resource.
}

~+ Mais 1 objeto

JSON

UserInvitation

Esquema para UserInvitation:

{
  properties: {
    expirationDate: string (ISO 8601 Format), # Optional. The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    notify: boolean, # Optional. Whether or not the recipient was notified via email.
    senderEmail: string, # Optional. Email address of the sender.
    senderName: string, # Optional. Name of the sender
    senderTenantName: string, # Optional. Tenant name of the sender
    sentAt: string (ISO 8601 Format), # Optional. Gets the time at which the invitation was sent. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
    shareStatus: "Detached" | "Attached", # Optional. Share status.
    state: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed", # Optional. State of the resource
    targetEmail: string, # Required. The receiver email for the invitation is being sent.
  }, # Required. Properties of the user invitation type.
  invitationKind: User, # Required. The types of invitations.
  id: string, # Optional. The unique id of the resource.
  type: string, # Optional. Type of the resource.
}

Aplica-se a

Compartilhar via