ReceivedSharesClient.GetReceivedShare(String, RequestContext) 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:: ReceivedSharesClient.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.

Obtenir un partage reçu par nom.

public virtual Azure.Response GetReceivedShare (string receivedShareName, Azure.RequestContext context = default);

abstract member GetReceivedShare : string * Azure.RequestContext -> Azure.Response
override this.GetReceivedShare : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetReceivedShare (receivedShareName As String, Optional context As RequestContext = Nothing) As Response

Paramètres

receivedShareName: String

Nom du partage reçu.

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

receivedShareName a la valeur null.

ArgumentException

receivedShareName est une chaîne vide et devait être non vide.

RequestFailedException

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

Exemples

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

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

Response response = client.GetReceivedShare("<receivedShareName>");

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("shareKind").ToString());

Remarques

Obtenir un partage reçu

Vous trouverez ci-dessous le schéma JSON pour la charge utile de réponse.

Corps de réponse :

InPlaceReceivedShare

Schéma pour InPlaceReceivedShare:

{
              shareKind: InPlace, # Required. Defines the supported types for share.
              id: string, # Optional. The resource id of the resource.
              name: string, # Optional. Name of the resource.
              type: string, # Optional. Type of the resource.
              properties: {
                collection: {
                  referenceName: string, # Required. Gets or sets the reference name.
                  type: string, # Required. Gets or sets the reference type property.
                }, # Required. Reference to a Collection.
                createdAt: string (ISO 8601 Format), # Optional. Time at which the received share was created.
                expirationDate: string (ISO 8601 Format), # Optional. The expiration date of the received share.
                invitationId: string, # Required. The invitation id.
                provisioningState: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed" | "SoftDeleting" | "SoftDeleted" | "SourceMoved" | "SourceDeleted" | "TargetMoved" | "TargetDeleted", # Optional. Provisioning status of the resource
                receivedShareStatus: "Active" | "Reinstating" | "Revoked" | "Revoking" | "RevokeFailed" | "ReinstateFailed" | "SourceDeleted", # Optional. received share status
                receiverEmail: string, # Optional. Email of the user/receiver who received the sent share invitation
                receiverName: string, # Optional. Name of the user/receiver who received the sent share invitation
                receiverTenantName: string, # Optional. Tenant name of the user/receiver who received the sent share invitation
                senderEmail: string, # Optional. Email of the sender who created the sent share invitation
                senderName: string, # Optional. Name of the sender who created the sent share invitation
                senderTenantName: string, # Optional. Tenant name of the sender who created the sent share invitation
                sentShareDescription: string, # Optional. Share description.
                sentShareLocation: string, # Required. Sent share location.
                sharedAt: string (ISO 8601 Format), # Optional. Time at which the sent share was shared.
                shareName: string, # Optional. Name of the share
              }, # Required. Properties of in place received share.
            }

S’applique à

Partager via